dendi-wang/thingsboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixed swagger description

Browse Source
This commit is contained in:
IrynaMatveieva 2024-08-14 15:50:21 +03:00
parent ed0a7d5adb
commit 0f4037155d
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
application/src/main/java/org/thingsboard/server/controller/AdminController.java
View File

@ -137,7 +137,7 @@ public class AdminController extends BaseController {
return adminSettings; return adminSettings;
} }
@ApiOperation(value = "Get the Administration Settings object using key (getAdminSettings)", @ApiOperation(value = "Creates or Updates the Administration Settings (saveAdminSettings)",
notes = "Creates or Updates the Administration Settings. Platform generates random Administration Settings Id during settings creation. " + notes = "Creates or Updates the Administration Settings. Platform generates random Administration Settings Id during settings creation. " +
"The Administration Settings Id will be present in the response. Specify the Administration Settings Id when you would like to update the Administration Settings. " + "The Administration Settings Id will be present in the response. Specify the Administration Settings Id when you would like to update the Administration Settings. " +
"Referencing non-existing Administration Settings Id will cause an error." + SYSTEM_AUTHORITY_PARAGRAPH) "Referencing non-existing Administration Settings Id will cause an error." + SYSTEM_AUTHORITY_PARAGRAPH)
@ -160,7 +160,7 @@ public class AdminController extends BaseController {
return adminSettings; return adminSettings;
} }
@ApiOperation(value = "Get the Security Settings object", @ApiOperation(value = "Get the Security Settings object (getSecuritySettings)",
notes = "Get the Security Settings object that contains password policy, etc." + SYSTEM_AUTHORITY_PARAGRAPH) notes = "Get the Security Settings object that contains password policy, etc." + SYSTEM_AUTHORITY_PARAGRAPH)
@PreAuthorize("hasAuthority('SYS_ADMIN')") @PreAuthorize("hasAuthority('SYS_ADMIN')")
@RequestMapping(value = "/securitySettings", method = RequestMethod.GET) @RequestMapping(value = "/securitySettings", method = RequestMethod.GET)
@ -237,7 +237,7 @@ public class AdminController extends BaseController {
} }
} }
@ApiOperation(value = "Send test sms (sendTestMail)", @ApiOperation(value = "Send test sms (sendTestSms)",
notes = "Attempts to send test sms to the System Administrator User using SMS Settings and phone number provided as a parameters of the request. " notes = "Attempts to send test sms to the System Administrator User using SMS Settings and phone number provided as a parameters of the request. "
+ SYSTEM_AUTHORITY_PARAGRAPH) + SYSTEM_AUTHORITY_PARAGRAPH)
@PreAuthorize("hasAuthority('SYS_ADMIN')") @PreAuthorize("hasAuthority('SYS_ADMIN')")

6
common/data/src/main/java/org/thingsboard/server/common/data/objects/AttributesEntityView.java
View File

@ -31,11 +31,11 @@ import java.util.List;
@NoArgsConstructor @NoArgsConstructor
public class AttributesEntityView implements Serializable { public class AttributesEntityView implements Serializable {
@Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "List of client-side attribute keys to expose", example = "currentConfiguration") @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "List of client-side attribute keys to expose", example = "[\"currentConfiguration\"]")
private List<String> cs = new ArrayList<>(); private List<String> cs = new ArrayList<>();
@Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "List of server-side attribute keys to expose", example = "model") @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "List of server-side attribute keys to expose", example = "[\"model\"]")
private List<String> ss = new ArrayList<>(); private List<String> ss = new ArrayList<>();
@Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "List of shared attribute keys to expose", example = "targetConfiguration") @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "List of shared attribute keys to expose", example = "[\"targetConfiguration\"]")
private List<String> sh = new ArrayList<>(); private List<String> sh = new ArrayList<>();
public AttributesEntityView(List<String> cs, public AttributesEntityView(List<String> cs,

2
common/data/src/main/java/org/thingsboard/server/common/data/objects/TelemetryEntityView.java
View File

@ -31,7 +31,7 @@ import java.util.List;
@NoArgsConstructor @NoArgsConstructor
public class TelemetryEntityView implements Serializable { public class TelemetryEntityView implements Serializable {
@Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "List of time-series data keys to expose", example = "temperature, humidity") @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "List of time-series data keys to expose", example = "[\"temperature\", \"humidity\"]")
private List<String> timeseries; private List<String> timeseries;
@Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "JSON object with attributes to expose") @Schema(requiredMode = Schema.RequiredMode.REQUIRED, description = "JSON object with attributes to expose")
private AttributesEntityView attributes; private AttributesEntityView attributes;