EntityId openspec improvements

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

@@ -680,9 +680,14 @@ public class SwaggerConfiguration {
         // Map backing field names to their JSON property names (respects @JsonProperty)
         Map<String, String> fieldToJsonName = new LinkedHashMap<>();
         LinkedHashSet<String> getterOnlyNames = new LinkedHashSet<>();
+        LinkedHashSet<String> writeOnlyNames = new LinkedHashSet<>();
         for (var prop : beanDesc.findProperties()) {
             if (prop.getField() != null) {
-                fieldToJsonName.put(prop.getField().getName(), prop.getName());
+                if (prop.couldSerialize()) {
+                    fieldToJsonName.put(prop.getField().getName(), prop.getName());
+                } else {
+                    writeOnlyNames.add(prop.getName());
+                }
             } else {
                 getterOnlyNames.add(prop.getName());
             }
@@ -704,6 +709,8 @@ public class SwaggerConfiguration {
 
         // Append getter-only properties (no backing field) at the end
         ordered.addAll(getterOnlyNames);
+        // Append write-only properties (e.g. deprecated setter-only fields) last
+        ordered.addAll(writeOnlyNames);
         return ordered;
     }
 

common/data/src/main/java/org/thingsboard/server/common/data/id/AdminSettingsId.java

@@ -23,6 +23,7 @@ import org.thingsboard.server.common.data.EntityType;
 import java.io.Serial;
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class AdminSettingsId extends UUIDBased implements EntityId {
 
     @Serial
@@ -33,7 +34,7 @@ public class AdminSettingsId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "ADMIN_SETTINGS", allowableValues = "ADMIN_SETTINGS")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "ADMIN_SETTINGS", allowableValues = "ADMIN_SETTINGS")
     @Override
     public EntityType getEntityType() {
         return EntityType.ADMIN_SETTINGS;

common/data/src/main/java/org/thingsboard/server/common/data/id/AiModelId.java

@@ -23,6 +23,7 @@ import org.thingsboard.server.common.data.EntityType;
 import java.io.Serial;
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public final class AiModelId extends UUIDBased implements EntityId {
 
     @Serial
@@ -36,6 +37,7 @@ public final class AiModelId extends UUIDBased implements EntityId {
     @Override
     @Schema(
             requiredMode = Schema.RequiredMode.REQUIRED,
+            accessMode = Schema.AccessMode.READ_ONLY,
             description = "Entity type of the AI model",
             example = "AI_MODEL",
             allowableValues = "AI_MODEL"

common/data/src/main/java/org/thingsboard/server/common/data/id/AlarmId.java

@@ -22,7 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public class AlarmId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -36,7 +36,7 @@ public class AlarmId extends UUIDBased implements EntityId {
         return new AlarmId(UUID.fromString(alarmId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "ALARM", allowableValues = "ALARM")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "ALARM", allowableValues = "ALARM")
     @Override
     public EntityType getEntityType() {
         return EntityType.ALARM;

common/data/src/main/java/org/thingsboard/server/common/data/id/ApiKeyId.java

@@ -23,6 +23,7 @@ import org.thingsboard.server.common.data.EntityType;
 import java.io.Serial;
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class ApiKeyId extends UUIDBased implements EntityId {
 
     @Serial
@@ -38,7 +39,7 @@ public class ApiKeyId extends UUIDBased implements EntityId {
     }
 
     @Override
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "API_KEY", allowableValues = "API_KEY")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "API_KEY", allowableValues = "API_KEY")
     public EntityType getEntityType() {
         return EntityType.API_KEY;
     }

common/data/src/main/java/org/thingsboard/server/common/data/id/ApiUsageStateId.java

@@ -22,7 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public class ApiUsageStateId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -34,7 +34,7 @@ public class ApiUsageStateId extends UUIDBased implements EntityId {
         return new ApiUsageStateId(UUID.fromString(userId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "API_USAGE_STATE", allowableValues = "API_USAGE_STATE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "API_USAGE_STATE", allowableValues = "API_USAGE_STATE")
     @Override
     public EntityType getEntityType() {
         return EntityType.API_USAGE_STATE;

common/data/src/main/java/org/thingsboard/server/common/data/id/AssetId.java

@@ -22,7 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public class AssetId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -36,7 +36,7 @@ public class AssetId extends UUIDBased implements EntityId {
         return new AssetId(UUID.fromString(assetId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "ASSET", allowableValues = "ASSET")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "ASSET", allowableValues = "ASSET")
     @Override
     public EntityType getEntityType() {
         return EntityType.ASSET;

common/data/src/main/java/org/thingsboard/server/common/data/id/AssetProfileId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class AssetProfileId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -35,7 +36,7 @@ public class AssetProfileId extends UUIDBased implements EntityId {
         return new AssetProfileId(UUID.fromString(assetProfileId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "ASSET_PROFILE", allowableValues = "ASSET_PROFILE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "ASSET_PROFILE", allowableValues = "ASSET_PROFILE")
     @Override
     public EntityType getEntityType() {
         return EntityType.ASSET_PROFILE;

common/data/src/main/java/org/thingsboard/server/common/data/id/CalculatedFieldId.java

@@ -23,7 +23,7 @@ import org.thingsboard.server.common.data.EntityType;
 import java.io.Serial;
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public class CalculatedFieldId extends UUIDBased implements EntityId {
 
     @Serial
@@ -38,7 +38,7 @@ public class CalculatedFieldId extends UUIDBased implements EntityId {
         return new CalculatedFieldId(UUID.fromString(calculatedFieldId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "CALCULATED_FIELD", allowableValues = "CALCULATED_FIELD")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "CALCULATED_FIELD", allowableValues = "CALCULATED_FIELD")
     @Override
     public EntityType getEntityType() {
         return EntityType.CALCULATED_FIELD;

common/data/src/main/java/org/thingsboard/server/common/data/id/CustomerId.java

@@ -22,7 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public final class CustomerId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -32,7 +32,7 @@ public final class CustomerId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "CUSTOMER", allowableValues = "CUSTOMER")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "CUSTOMER", allowableValues = "CUSTOMER")
     @Override
     public EntityType getEntityType() {
         return EntityType.CUSTOMER;

common/data/src/main/java/org/thingsboard/server/common/data/id/DashboardId.java

@@ -22,7 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public class DashboardId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -34,7 +34,7 @@ public class DashboardId extends UUIDBased implements EntityId {
         return new DashboardId(UUID.fromString(dashboardId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "DASHBOARD", allowableValues = "DASHBOARD")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "DASHBOARD", allowableValues = "DASHBOARD")
     @Override
     public EntityType getEntityType() {
         return EntityType.DASHBOARD;

common/data/src/main/java/org/thingsboard/server/common/data/id/DeviceId.java

@@ -22,7 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public class DeviceId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -37,7 +37,7 @@ public class DeviceId extends UUIDBased implements EntityId {
     }
 
     @Override
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "DEVICE", allowableValues = "DEVICE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "DEVICE", allowableValues = "DEVICE")
     public EntityType getEntityType() {
         return EntityType.DEVICE;
     }

common/data/src/main/java/org/thingsboard/server/common/data/id/DeviceProfileId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class DeviceProfileId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -35,7 +36,7 @@ public class DeviceProfileId extends UUIDBased implements EntityId {
         return new DeviceProfileId(UUID.fromString(deviceProfileId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "DEVICE_PROFILE", allowableValues = "DEVICE_PROFILE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "DEVICE_PROFILE", allowableValues = "DEVICE_PROFILE")
     @Override
     public EntityType getEntityType() {
         return EntityType.DEVICE_PROFILE;

common/data/src/main/java/org/thingsboard/server/common/data/id/DomainId.java

@@ -17,10 +17,12 @@ package org.thingsboard.server.common.data.id;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class DomainId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -32,6 +34,7 @@ public class DomainId extends UUIDBased implements EntityId {
         return new DomainId(UUID.fromString(oauth2DomainId));
     }
 
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "DOMAIN", allowableValues = "DOMAIN")
     @Override
     public EntityType getEntityType() {
         return EntityType.DOMAIN;

common/data/src/main/java/org/thingsboard/server/common/data/id/EdgeId.java

@@ -26,6 +26,7 @@ import org.thingsboard.server.common.data.EntityType;
 import java.io.Serial;
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class EdgeId extends UUIDBased implements EntityId {
 
     @Serial
@@ -43,7 +44,7 @@ public class EdgeId extends UUIDBased implements EntityId {
         return new EdgeId(UUID.fromString(edgeId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "EDGE", allowableValues = "EDGE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "EDGE", allowableValues = "EDGE")
     @Override
     public EntityType getEntityType() {
         return EntityType.EDGE;

common/data/src/main/java/org/thingsboard/server/common/data/id/EntityId.java

@@ -18,6 +18,7 @@ package org.thingsboard.server.common.data.id;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.swagger.v3.oas.annotations.media.DiscriminatorMapping;
 import io.swagger.v3.oas.annotations.media.Schema;
 import org.thingsboard.server.common.data.EntityType;
 
@@ -26,7 +27,47 @@ import java.util.UUID;
 
 @JsonDeserialize(using = EntityIdDeserializer.class)
 @JsonSerialize(using = EntityIdSerializer.class)
-@Schema
+@Schema(
+        discriminatorProperty = "entityType",
+        discriminatorMapping = {
+                @DiscriminatorMapping(value = "ADMIN_SETTINGS", schema = AdminSettingsId.class),
+                @DiscriminatorMapping(value = "AI_MODEL", schema = AiModelId.class),
+                @DiscriminatorMapping(value = "ALARM", schema = AlarmId.class),
+                @DiscriminatorMapping(value = "API_KEY", schema = ApiKeyId.class),
+                @DiscriminatorMapping(value = "API_USAGE_STATE", schema = ApiUsageStateId.class),
+                @DiscriminatorMapping(value = "ASSET", schema = AssetId.class),
+                @DiscriminatorMapping(value = "ASSET_PROFILE", schema = AssetProfileId.class),
+                @DiscriminatorMapping(value = "CALCULATED_FIELD", schema = CalculatedFieldId.class),
+                @DiscriminatorMapping(value = "CUSTOMER", schema = CustomerId.class),
+                @DiscriminatorMapping(value = "DASHBOARD", schema = DashboardId.class),
+                @DiscriminatorMapping(value = "DEVICE", schema = DeviceId.class),
+                @DiscriminatorMapping(value = "DEVICE_PROFILE", schema = DeviceProfileId.class),
+                @DiscriminatorMapping(value = "DOMAIN", schema = DomainId.class),
+                @DiscriminatorMapping(value = "EDGE", schema = EdgeId.class),
+                @DiscriminatorMapping(value = "ENTITY_VIEW", schema = EntityViewId.class),
+                @DiscriminatorMapping(value = "JOB", schema = JobId.class),
+                @DiscriminatorMapping(value = "MOBILE_APP", schema = MobileAppId.class),
+                @DiscriminatorMapping(value = "MOBILE_APP_BUNDLE", schema = MobileAppBundleId.class),
+                @DiscriminatorMapping(value = "NOTIFICATION", schema = NotificationId.class),
+                @DiscriminatorMapping(value = "NOTIFICATION_REQUEST", schema = NotificationRequestId.class),
+                @DiscriminatorMapping(value = "NOTIFICATION_RULE", schema = NotificationRuleId.class),
+                @DiscriminatorMapping(value = "NOTIFICATION_TARGET", schema = NotificationTargetId.class),
+                @DiscriminatorMapping(value = "NOTIFICATION_TEMPLATE", schema = NotificationTemplateId.class),
+                @DiscriminatorMapping(value = "OAUTH2_CLIENT", schema = OAuth2ClientId.class),
+                @DiscriminatorMapping(value = "OTA_PACKAGE", schema = OtaPackageId.class),
+                @DiscriminatorMapping(value = "QUEUE", schema = QueueId.class),
+                @DiscriminatorMapping(value = "QUEUE_STATS", schema = QueueStatsId.class),
+                @DiscriminatorMapping(value = "RPC", schema = RpcId.class),
+                @DiscriminatorMapping(value = "RULE_CHAIN", schema = RuleChainId.class),
+                @DiscriminatorMapping(value = "RULE_NODE", schema = RuleNodeId.class),
+                @DiscriminatorMapping(value = "TB_RESOURCE", schema = TbResourceId.class),
+                @DiscriminatorMapping(value = "TENANT", schema = TenantId.class),
+                @DiscriminatorMapping(value = "TENANT_PROFILE", schema = TenantProfileId.class),
+                @DiscriminatorMapping(value = "USER", schema = UserId.class),
+                @DiscriminatorMapping(value = "WIDGETS_BUNDLE", schema = WidgetsBundleId.class),
+                @DiscriminatorMapping(value = "WIDGET_TYPE", schema = WidgetTypeId.class)
+        }
+)
 public interface EntityId extends HasUUID, Serializable { //NOSONAR, the constant is closely related to EntityId
 
     UUID NULL_UUID = UUID.fromString("13814000-1dd2-11b2-8080-808080808080");

common/data/src/main/java/org/thingsboard/server/common/data/id/EntityViewId.java

@@ -25,6 +25,7 @@ import java.util.UUID;
 /**
  * Created by Victor Basanets on 8/27/2017.
  */
+@Schema(allOf = EntityId.class)
 public class EntityViewId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -38,7 +39,7 @@ public class EntityViewId extends UUIDBased implements EntityId {
         return new EntityViewId(UUID.fromString(entityViewID));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "ENTITY_VIEW", allowableValues = "ENTITY_VIEW")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "ENTITY_VIEW", allowableValues = "ENTITY_VIEW")
     @Override
     public EntityType getEntityType() {
         return EntityType.ENTITY_VIEW;

common/data/src/main/java/org/thingsboard/server/common/data/id/JobId.java

@@ -23,6 +23,7 @@ import org.thingsboard.server.common.data.EntityType;
 import java.io.Serial;
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class JobId extends UUIDBased implements EntityId {
 
     @Serial
@@ -33,7 +34,7 @@ public class JobId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "JOB", allowableValues = "JOB")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "JOB", allowableValues = "JOB")
     @Override
     public EntityType getEntityType() {
         return EntityType.JOB;

common/data/src/main/java/org/thingsboard/server/common/data/id/MobileAppBundleId.java

@@ -17,10 +17,12 @@ package org.thingsboard.server.common.data.id;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class MobileAppBundleId extends UUIDBased implements EntityId{
 
     @JsonCreator
@@ -32,6 +34,7 @@ public class MobileAppBundleId extends UUIDBased implements EntityId{
         return new MobileAppBundleId(UUID.fromString(mobileAppId));
     }
 
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "MOBILE_APP_BUNDLE", allowableValues = "MOBILE_APP_BUNDLE")
     @Override
     public EntityType getEntityType() {
         return EntityType.MOBILE_APP_BUNDLE;

common/data/src/main/java/org/thingsboard/server/common/data/id/MobileAppId.java

@@ -17,10 +17,12 @@ package org.thingsboard.server.common.data.id;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class MobileAppId extends UUIDBased implements EntityId{
 
     @JsonCreator
@@ -32,6 +34,7 @@ public class MobileAppId extends UUIDBased implements EntityId{
         return new MobileAppId(UUID.fromString(mobileAppId));
     }
 
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "MOBILE_APP", allowableValues = "MOBILE_APP")
     @Override
     public EntityType getEntityType() {
         return EntityType.MOBILE_APP;

common/data/src/main/java/org/thingsboard/server/common/data/id/NotificationId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class NotificationId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -29,7 +30,7 @@ public class NotificationId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "NOTIFICATION", allowableValues = "NOTIFICATION")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "NOTIFICATION", allowableValues = "NOTIFICATION")
     @Override
     public EntityType getEntityType() {
         return EntityType.NOTIFICATION;

common/data/src/main/java/org/thingsboard/server/common/data/id/NotificationRequestId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class NotificationRequestId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -29,7 +30,7 @@ public class NotificationRequestId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "NOTIFICATION_REQUEST", allowableValues = "NOTIFICATION_REQUEST")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "NOTIFICATION_REQUEST", allowableValues = "NOTIFICATION_REQUEST")
     @Override
     public EntityType getEntityType() {
         return EntityType.NOTIFICATION_REQUEST;

common/data/src/main/java/org/thingsboard/server/common/data/id/NotificationRuleId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class NotificationRuleId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -29,7 +30,7 @@ public class NotificationRuleId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "NOTIFICATION_RULE", allowableValues = "NOTIFICATION_RULE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "NOTIFICATION_RULE", allowableValues = "NOTIFICATION_RULE")
     @Override
     public EntityType getEntityType() {
         return EntityType.NOTIFICATION_RULE;

common/data/src/main/java/org/thingsboard/server/common/data/id/NotificationTargetId.java

@@ -22,7 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public class NotificationTargetId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -30,7 +30,7 @@ public class NotificationTargetId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "NOTIFICATION_TARGET", allowableValues = "NOTIFICATION_TARGET")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "NOTIFICATION_TARGET", allowableValues = "NOTIFICATION_TARGET")
     @Override
     public EntityType getEntityType() {
         return EntityType.NOTIFICATION_TARGET;

common/data/src/main/java/org/thingsboard/server/common/data/id/NotificationTemplateId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class NotificationTemplateId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -29,7 +30,7 @@ public class NotificationTemplateId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "NOTIFICATION_TEMPLATE", allowableValues = "NOTIFICATION_TEMPLATE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "NOTIFICATION_TEMPLATE", allowableValues = "NOTIFICATION_TEMPLATE")
     @Override
     public EntityType getEntityType() {
         return EntityType.NOTIFICATION_TEMPLATE;

common/data/src/main/java/org/thingsboard/server/common/data/id/OAuth2ClientId.java

@@ -17,10 +17,12 @@ package org.thingsboard.server.common.data.id;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
 import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class OAuth2ClientId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -32,6 +34,7 @@ public class OAuth2ClientId extends UUIDBased implements EntityId {
         return new OAuth2ClientId(UUID.fromString(oauth2ClientId));
     }
 
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "OAUTH2_CLIENT", allowableValues = "OAUTH2_CLIENT")
     @Override
     public EntityType getEntityType() {
         return EntityType.OAUTH2_CLIENT;

common/data/src/main/java/org/thingsboard/server/common/data/id/OtaPackageId.java

@@ -23,6 +23,7 @@ import org.thingsboard.server.common.data.EntityType;
 import java.io.Serial;
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class OtaPackageId extends UUIDBased implements EntityId {
 
     @Serial
@@ -37,7 +38,7 @@ public class OtaPackageId extends UUIDBased implements EntityId {
         return new OtaPackageId(UUID.fromString(firmwareId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "OTA_PACKAGE", allowableValues = "OTA_PACKAGE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "OTA_PACKAGE", allowableValues = "OTA_PACKAGE")
     @Override
     public EntityType getEntityType() {
         return EntityType.OTA_PACKAGE;

common/data/src/main/java/org/thingsboard/server/common/data/id/QueueId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class QueueId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -35,7 +36,7 @@ public class QueueId extends UUIDBased implements EntityId {
         return new QueueId(UUID.fromString(queueId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "QUEUE", allowableValues = "QUEUE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "QUEUE", allowableValues = "QUEUE")
     @Override
     public EntityType getEntityType() {
         return EntityType.QUEUE;

common/data/src/main/java/org/thingsboard/server/common/data/id/QueueStatsId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class QueueStatsId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -35,7 +36,7 @@ public class QueueStatsId extends UUIDBased implements EntityId {
         return new QueueStatsId(UUID.fromString(queueId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "QUEUE_STATS", allowableValues = "QUEUE_STATS")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "QUEUE_STATS", allowableValues = "QUEUE_STATS")
     @Override
     public EntityType getEntityType() {
         return EntityType.QUEUE_STATS;

common/data/src/main/java/org/thingsboard/server/common/data/id/RpcId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public final class RpcId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -31,7 +32,7 @@ public final class RpcId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "RPC", allowableValues = "RPC")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "RPC", allowableValues = "RPC")
     @Override
     public EntityType getEntityType() {
         return EntityType.RPC;

common/data/src/main/java/org/thingsboard/server/common/data/id/RuleChainId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class RuleChainId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -29,7 +30,7 @@ public class RuleChainId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "RULE_CHAIN", allowableValues = "RULE_CHAIN")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "RULE_CHAIN", allowableValues = "RULE_CHAIN")
     @Override
     public EntityType getEntityType() {
         return EntityType.RULE_CHAIN;

common/data/src/main/java/org/thingsboard/server/common/data/id/RuleNodeId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class RuleNodeId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -29,7 +30,7 @@ public class RuleNodeId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "RULE_NODE", allowableValues = "RULE_NODE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "RULE_NODE", allowableValues = "RULE_NODE")
     @Override
     public EntityType getEntityType() {
         return EntityType.RULE_NODE;

common/data/src/main/java/org/thingsboard/server/common/data/id/TbResourceId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class TbResourceId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -31,7 +32,7 @@ public class TbResourceId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "TB_RESOURCE", allowableValues = "TB_RESOURCE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "TB_RESOURCE", allowableValues = "TB_RESOURCE")
     @Override
     public EntityType getEntityType() {
         return EntityType.TB_RESOURCE;

common/data/src/main/java/org/thingsboard/server/common/data/id/TenantId.java

@@ -26,6 +26,7 @@ import org.thingsboard.server.common.data.EntityType;
 import java.io.Serial;
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public final class TenantId extends UUIDBased implements EntityId {
 
     @JsonIgnore
@@ -54,7 +55,7 @@ public final class TenantId extends UUIDBased implements EntityId {
         return this.equals(SYS_TENANT_ID);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "TENANT", allowableValues = "TENANT")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "TENANT", allowableValues = "TENANT")
     @Override
     public EntityType getEntityType() {
         return EntityType.TENANT;

common/data/src/main/java/org/thingsboard/server/common/data/id/TenantProfileId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public class TenantProfileId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -35,7 +36,7 @@ public class TenantProfileId extends UUIDBased implements EntityId {
         return new TenantProfileId(UUID.fromString(tenantProfileId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "TENANT_PROFILE", allowableValues = "TENANT_PROFILE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "TENANT_PROFILE", allowableValues = "TENANT_PROFILE")
     @Override
     public EntityType getEntityType() {
         return EntityType.TENANT_PROFILE;

common/data/src/main/java/org/thingsboard/server/common/data/id/UserId.java

@@ -22,7 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
-@Schema
+@Schema(allOf = EntityId.class)
 public class UserId extends UUIDBased implements EntityId {
 
     @JsonCreator
@@ -34,7 +34,7 @@ public class UserId extends UUIDBased implements EntityId {
         return new UserId(UUID.fromString(userId));
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "USER", allowableValues = "USER")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "USER", allowableValues = "USER")
     @Override
     public EntityType getEntityType() {
         return EntityType.USER;

common/data/src/main/java/org/thingsboard/server/common/data/id/WidgetTypeId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public final class WidgetTypeId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -31,7 +32,7 @@ public final class WidgetTypeId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "WIDGET_TYPE", allowableValues = "WIDGET_TYPE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "WIDGET_TYPE", allowableValues = "WIDGET_TYPE")
     @Override
     public EntityType getEntityType() {
         return EntityType.WIDGET_TYPE;

common/data/src/main/java/org/thingsboard/server/common/data/id/WidgetsBundleId.java

@@ -22,6 +22,7 @@ import org.thingsboard.server.common.data.EntityType;
 
 import java.util.UUID;
 
+@Schema(allOf = EntityId.class)
 public final class WidgetsBundleId extends UUIDBased implements EntityId {
 
     private static final long serialVersionUID = 1L;
@@ -31,7 +32,7 @@ public final class WidgetsBundleId extends UUIDBased implements EntityId {
         super(id);
     }
 
-    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "string", example = "WIDGETS_BUNDLE", allowableValues = "WIDGETS_BUNDLE")
+    @Schema(requiredMode = Schema.RequiredMode.REQUIRED, accessMode = Schema.AccessMode.READ_ONLY, description = "string", example = "WIDGETS_BUNDLE", allowableValues = "WIDGETS_BUNDLE")
     @Override
     public EntityType getEntityType() {
         return EntityType.WIDGETS_BUNDLE;

common/data/src/main/java/org/thingsboard/server/common/data/sync/ie/EntityExportData.java

@@ -110,7 +110,6 @@ public abstract class EntityExportData<E extends ExportableEntity<? extends Enti
     @JsonTbEntity
     @Schema(implementation = ExportableEntity.class)
     private E entity;
-
     @JsonProperty(index = 1)
     @Schema(requiredMode = Schema.RequiredMode.REQUIRED)
     public abstract EntityType getEntityType();