community/device-mgt-core
1
0
Fork 0
mirror of https://repository.entgra.net/community/device-mgt-core.git synced 2025-10-06 02:01:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve API interface text

Browse Source
This commit is contained in:
tcdlpds@gmail.com 2020-10-01 00:40:58 +05:30
parent f41bf699ec
commit b3d1badd1f
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/admin/DeviceManagementAdminService.java
View File

@ -362,14 +362,14 @@ public interface DeviceManagementAdminService {
List<String> deviceIdentifiers); List<String> deviceIdentifiers);
@POST @POST
@Path("/{deviceId}/{featureCode}/") @Path("/{deviceId}/{featureCode}")
@ApiOperation( @ApiOperation(
consumes = MediaType.APPLICATION_JSON, consumes = MediaType.APPLICATION_JSON,
produces = MediaType.APPLICATION_JSON, produces = MediaType.APPLICATION_JSON,
httpMethod = "POST", httpMethod = "POST",
value = "Removing Multiple Policies", value = "Trigger the given corrective action",
notes = "Delete one or more than one policy using this API.", notes = "When violation happens it is possible to trigger a corrective action.",
tags = "Device Policy Management", tags = "Device Management",
extensions = { extensions = {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:android:enroll") @ExtensionProperty(name = Constants.SCOPE, value = "perm:android:enroll")
@ -380,7 +380,7 @@ public interface DeviceManagementAdminService {
value = { value = {
@ApiResponse( @ApiResponse(
code = 200, code = 200,
message = "OK. \n Successfully removed the policy."), message = "OK. \n Successfully triggered the action."),
@ApiResponse( @ApiResponse(
code = 400, code = 400,
message = "Bad Request. \n Invalid request or validation error.", message = "Bad Request. \n Invalid request or validation error.",
@ -397,7 +397,7 @@ public interface DeviceManagementAdminService {
@ApiResponse( @ApiResponse(
code = 500, code = 500,
message = "Internal Server Error. \n " + message = "Internal Server Error. \n " +
"Server error occurred whilst bulk removing policies.", "Server error occurred while triggering the corrective action.",
response = ErrorResponse.class) response = ErrorResponse.class)
}) })
Response triggerCorrectiveActions( Response triggerCorrectiveActions(
@ -415,7 +415,7 @@ public interface DeviceManagementAdminService {
String featureCode, String featureCode,
@ApiParam( @ApiParam(
name = "actions", name = "actions",
value = "The list of actions to trigger when policy violated.", value = "The list of actions to trigger when violation happens.",
required = true) required = true)
List<String> actions List<String> actions
); );