Browse Source

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.
pull/15865/head
dshvaika 3 weeks ago
parent
commit
852026ff3f
  1. 4
      common/transport/http/src/main/java/org/thingsboard/server/transport/http/DeviceApiController.java

4
common/transport/http/src/main/java/org/thingsboard/server/transport/http/DeviceApiController.java

@ -141,9 +141,9 @@ public class DeviceApiController implements TbTransportService {
public DeferredResult<ResponseEntity> 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,

Loading…
Cancel
Save