From 852026ff3f2bbfcb5adf4bdda5c8b2e63813b213 Mon Sep 17 00:00:00 2001 From: dshvaika Date: Tue, 30 Jun 2026 18:15:29 +0300 Subject: [PATCH] docs(attributes): drop stale Swagger defaults on HTTP clientKeys/sharedKeys The @Schema(defaultValue="state"/"configuration") advertised default keys that are no longer applied (params now default to empty). Replace with a note pointing to allClientKeys/allSharedKeys for fetching a whole scope. --- .../server/transport/http/DeviceApiController.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/common/transport/http/src/main/java/org/thingsboard/server/transport/http/DeviceApiController.java b/common/transport/http/src/main/java/org/thingsboard/server/transport/http/DeviceApiController.java index c61e7c1d2a..be7c1deff6 100644 --- a/common/transport/http/src/main/java/org/thingsboard/server/transport/http/DeviceApiController.java +++ b/common/transport/http/src/main/java/org/thingsboard/server/transport/http/DeviceApiController.java @@ -141,9 +141,9 @@ public class DeviceApiController implements TbTransportService { public DeferredResult getDeviceAttributes( @Parameter(description = ACCESS_TOKEN_PARAM_DESCRIPTION, required = true, schema = @Schema(defaultValue = "YOUR_DEVICE_ACCESS_TOKEN")) @PathVariable("deviceToken") String deviceToken, - @Parameter(description = "Comma separated key names for attribute with client scope", required = false, schema = @Schema(defaultValue = "state")) + @Parameter(description = "Comma separated key names for attribute with client scope. Leave empty and set allClientKeys=true to fetch all client-scope attributes", required = false) @RequestParam(value = "clientKeys", required = false, defaultValue = "") String clientKeys, - @Parameter(description = "Comma separated key names for attribute with shared scope", required = false, schema = @Schema(defaultValue = "configuration")) + @Parameter(description = "Comma separated key names for attribute with shared scope. Leave empty and set allSharedKeys=true to fetch all shared-scope attributes", required = false) @RequestParam(value = "sharedKeys", required = false, defaultValue = "") String sharedKeys, @Parameter(description = "Set to true to return ALL client-scope attributes (ignores clientKeys)") @RequestParam(value = "allClientKeys", required = false, defaultValue = "false") boolean allClientKeys,