pasindu
/
device-mgt-core
forked from community/device-mgt-core
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix swagger syntax issues

Browse Source
license
inoshperera 2 years ago
parent 223637c887
commit 259795a274
14 changed files with 99 additions and 41 deletions
Show Stats Download Patch File Download Diff File

6
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/beans/ActivityList.java
Unescape View File

@ -26,14 +26,14 @@ import org.wso2.carbon.device.mgt.common.operation.mgt.Activity;
import java.util.List; import java.util.List;
@ApiModel(value = "List of activities", description = "This contains a set of activities that matches a given" @ApiModel(value = "ListOfActivities", description = "This contains a set of activities that " +
"matches a given"
+ " criteria as a collection") + " criteria as a collection")
public class ActivityList extends BasePaginatedResult { public class ActivityList extends BasePaginatedResult {
private List<Activity> activities; private List<Activity> activities;
@ApiModelProperty(value = "Returns the list of activities that match the offset and limit parameter values" @ApiModelProperty(value = "List of activity Ids")
+ " that were specified.")
@JsonProperty("activities") @JsonProperty("activities")
public List<Activity> getList() { public List<Activity> getList() {
return activities; return activities;

16
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/beans/DeviceTypeVersionWrapper.java
Unescape View File

@ -17,9 +17,25 @@
*/ */
package org.wso2.carbon.device.mgt.jaxrs.beans; package org.wso2.carbon.device.mgt.jaxrs.beans;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
@ApiModel(value = "DeviceTypeVersionWrapper", description = "Provides details about the device " +
"type version and statues")
public class DeviceTypeVersionWrapper { public class DeviceTypeVersionWrapper {
@ApiModelProperty(
name = "versionName",
value = "Sub version name of the device type (example OS version)",
required = true,
example = "8.1")
String versionName; String versionName;
@ApiModelProperty(
name = "versionStatus",
value = "ACTIVE or INACTIVE status of this version",
required = true,
example = "ACTIVE")
String versionStatus; String versionStatus;
public String getVersionName() { public String getVersionName() {

14
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/common/ActivityIdList.java
Unescape View File

@ -18,12 +18,26 @@
package org.wso2.carbon.device.mgt.jaxrs.common; package org.wso2.carbon.device.mgt.jaxrs.common;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.Arrays; import java.util.Arrays;
import java.util.List; import java.util.List;
@ApiModel(value = "ActivityIdList", description = "List of activity IDs")
public class ActivityIdList { public class ActivityIdList {
@ApiModelProperty(
name = "operationId",
value = "operation Id",
example = "1")
private String ids; private String ids;
@ApiModelProperty(
name = "activityId",
value = "Activity identifiers",
required = true,
example = "ACTIVITY_1, ACTIVITY_2")
private List<String> idList; private List<String> idList;
public ActivityIdList(String ids) { public ActivityIdList(String ids) {

12
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/ActivityInfoProviderService.java
Unescape View File

@ -37,6 +37,7 @@ import org.wso2.carbon.device.mgt.jaxrs.beans.ErrorResponse;
import org.wso2.carbon.device.mgt.jaxrs.common.ActivityIdList; import org.wso2.carbon.device.mgt.jaxrs.common.ActivityIdList;
import org.wso2.carbon.device.mgt.jaxrs.util.Constants; import org.wso2.carbon.device.mgt.jaxrs.util.Constants;
import javax.validation.Valid;
import javax.validation.constraints.Size; import javax.validation.constraints.Size;
import javax.ws.rs.Consumes; import javax.ws.rs.Consumes;
import javax.ws.rs.DefaultValue; import javax.ws.rs.DefaultValue;
@ -173,7 +174,8 @@ public interface ActivityInfoProviderService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:get-activity") @ExtensionProperty(name = Constants.SCOPE, value = "perm:get-activity")
}) })
} },
nickname = "getActivitiesByActivityIdList"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse( @ApiResponse(
@ -220,7 +222,7 @@ public interface ActivityInfoProviderService {
value = "Comma separated activity/operation IDs", value = "Comma separated activity/operation IDs",
required = true, required = true,
defaultValue = "ACTIVITY_0") defaultValue = "ACTIVITY_0")
@QueryParam("ids") ActivityIdList activityIdList); ActivityIdList activityIdList);
@GET @GET
@ -322,7 +324,8 @@ public interface ActivityInfoProviderService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:get-activity") @ExtensionProperty(name = Constants.SCOPE, value = "perm:get-activity")
}) })
} },
nickname = "getActivitiesByOperationCode"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse( @ApiResponse(
@ -385,7 +388,8 @@ public interface ActivityInfoProviderService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:get-activity") @ExtensionProperty(name = Constants.SCOPE, value = "perm:get-activity")
}) })
} },
nickname = "getActivitiesWithFilters"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse( @ApiResponse(

6
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceAgentService.java
Unescape View File

@ -264,7 +264,8 @@ public interface DeviceAgentService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:device:publish-event") @ExtensionProperty(name = Constants.SCOPE, value = "perm:device:publish-event")
}) })
} },
nickname = "publishEventFromAgent"
) )
@ApiResponses( @ApiResponses(
value = { value = {
@ -329,7 +330,8 @@ public interface DeviceAgentService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:device:publish-event") @ExtensionProperty(name = Constants.SCOPE, value = "perm:device:publish-event")
}) })
} },
nickname = "publishEventsByTypeAndDevice"
) )
@ApiResponses( @ApiResponses(
value = { value = {

38
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceManagementService.java
Unescape View File

@ -401,21 +401,25 @@ public interface DeviceManagementService {
name = "tenantDomain", name = "tenantDomain",
value = "The tenant domain.", value = "The tenant domain.",
required = false) required = false)
@QueryParam("tenantDomain")
String tenantDomain, String tenantDomain,
@ApiParam( @ApiParam(
name = "startDate", name = "startDate",
value = "The start date.", value = "The start date.",
required = false) required = false)
@QueryParam("startDate")
Timestamp startDate, Timestamp startDate,
@ApiParam( @ApiParam(
name = "endDate", name = "endDate",
value = "The end date.", value = "The end date.",
required = false) required = false)
@QueryParam("endDate")
Timestamp endDate, Timestamp endDate,
@ApiParam( @ApiParam(
name = "generateBill", name = "generateBill",
value = "The generate bill boolean.", value = "The generate bill boolean.",
required = false) required = false)
@QueryParam("generateBill")
boolean generateBill, boolean generateBill,
@ApiParam( @ApiParam(
name = "offset", name = "offset",
@ -492,21 +496,25 @@ public interface DeviceManagementService {
name = "tenantDomain", name = "tenantDomain",
value = "The tenant domain.", value = "The tenant domain.",
required = false) required = false)
@QueryParam("tenantDomain")
String tenantDomain, String tenantDomain,
@ApiParam( @ApiParam(
name = "startDate", name = "startDate",
value = "The start date.", value = "The start date.",
required = false) required = false)
@QueryParam("startDate")
Timestamp startDate, Timestamp startDate,
@ApiParam( @ApiParam(
name = "endDate", name = "endDate",
value = "The end date.", value = "The end date.",
required = false) required = false)
@QueryParam("endDate")
Timestamp endDate, Timestamp endDate,
@ApiParam( @ApiParam(
name = "generateBill", name = "generateBill",
value = "The generate bill boolean.", value = "The generate bill boolean.",
required = false) required = false)
@QueryParam("generateBill")
boolean generateBill); boolean generateBill);
@GET @GET
@ -862,7 +870,7 @@ public interface DeviceManagementService {
}) })
Response getDeviceLocationInfo( Response getDeviceLocationInfo(
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type, such as ios, android, or windows.", value = "The device type, such as ios, android, or windows.",
required = true) required = true)
@PathParam("deviceType") @PathParam("deviceType")
@ -1286,14 +1294,14 @@ public interface DeviceManagementService {
required = true) required = true)
Device device, Device device,
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type, such as ios, android, or windows.", value = "The device type, such as ios, android, or windows.",
required = true) required = true)
@PathParam("deviceType") @PathParam("deviceType")
@Size(max = 45) @Size(max = 45)
String deviceType, String deviceType,
@ApiParam( @ApiParam(
name = "device-id", name = "deviceId",
value = "The device identifier of the device.", value = "The device identifier of the device.",
required = true) required = true)
@PathParam("deviceId") @PathParam("deviceId")
@ -1315,7 +1323,8 @@ public interface DeviceManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:devices:delete") @ExtensionProperty(name = Constants.SCOPE, value = "perm:devices:delete")
}) })
} },
nickname = "deleteDeviceByTypeAndId"
) )
@ApiResponses( @ApiResponses(
value = { value = {
@ -1356,14 +1365,14 @@ public interface DeviceManagementService {
}) })
Response deleteDevice( Response deleteDevice(
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type, such as ios, android, or windows.", value = "The device type, such as ios, android, or windows.",
required = true) required = true)
@PathParam("deviceType") @PathParam("deviceType")
@Size(max = 45) @Size(max = 45)
String deviceType, String deviceType,
@ApiParam( @ApiParam(
name = "device-id", name = "deviceId",
value = "The device identifier of the device.", value = "The device identifier of the device.",
required = true) required = true)
@PathParam("deviceId") @PathParam("deviceId")
@ -2546,7 +2555,7 @@ public interface DeviceManagementService {
}) })
Response getPolicyCompliance( Response getPolicyCompliance(
@ApiParam( @ApiParam(
name = "compliance-status", name = "complianceStatus",
value = "Compliance status for devices. If true, devices which are compliant with policies. " + value = "Compliance status for devices. If true, devices which are compliant with policies. " +
"If false, devices which are not compliant", "If false, devices which are not compliant",
required = true) required = true)
@ -2587,7 +2596,7 @@ public interface DeviceManagementService {
@ApiOperation( @ApiOperation(
produces = MediaType.APPLICATION_JSON, produces = MediaType.APPLICATION_JSON,
httpMethod = "GET", httpMethod = "GET",
value = "Getting Policy Compliance Status of all devices", value = "Getting non compliant policy features",
notes = "A policy is enforced on the devices that register with Entgra IoTS. " + notes = "A policy is enforced on the devices that register with Entgra IoTS. " +
"The server checks if the settings in the device comply with the policy that is enforced on the device using this REST API.", "The server checks if the settings in the device comply with the policy that is enforced on the device using this REST API.",
tags = "Device Management", tags = "Device Management",
@ -2665,7 +2674,7 @@ public interface DeviceManagementService {
}) })
Response getApplications( Response getApplications(
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "Device type (platform) of the application", value = "Device type (platform) of the application",
required = true) required = true)
@PathParam("deviceType") @PathParam("deviceType")
@ -2722,7 +2731,7 @@ public interface DeviceManagementService {
}) })
Response getAppVersions( Response getAppVersions(
@ApiParam( @ApiParam(
name = "package-name", name = "packageName",
value = "The package name of the app.", value = "The package name of the app.",
required = true) required = true)
@PathParam("packageName") @PathParam("packageName")
@ -2771,7 +2780,7 @@ public interface DeviceManagementService {
}) })
Response updateOperationStatus( Response updateOperationStatus(
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type, such as ios, android, or windows.") value = "The device type, such as ios, android, or windows.")
@PathParam("deviceType") String deviceType, @PathParam("deviceType") String deviceType,
@ApiParam( @ApiParam(
@ -2860,17 +2869,20 @@ public interface DeviceManagementService {
) )
Response getDefaultToken( Response getDefaultToken(
@ApiParam( @ApiParam(
name = "client ID", name = "clientId",
value = "Client Id.", value = "Client Id.",
required = true) required = true)
@PathParam("clientId") @PathParam("clientId")
String clientId, String clientId,
@ApiParam( @ApiParam(
name = "client secret", name = "clientSecret",
value = "Client Secret", value = "Client Secret",
required = true) required = true)
@PathParam("clientSecret") @PathParam("clientSecret")
String clientSecret, String clientSecret,
@ApiParam(
name = "scopes",
value = "Oauth scopes")
@QueryParam("scopes") String scopes @QueryParam("scopes") String scopes
); );
} }

6
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceTypeManagementService.java
Unescape View File

@ -131,7 +131,8 @@ public interface DeviceTypeManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:device-types:types") @ExtensionProperty(name = Constants.SCOPE, value = "perm:device-types:types")
}) })
} },
nickname = "getAllDeviceTypesPaginated"
) )
@ApiResponses( @ApiResponses(
value = { value = {
@ -212,7 +213,8 @@ public interface DeviceTypeManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:device-types:types") @ExtensionProperty(name = Constants.SCOPE, value = "perm:device-types:types")
}) })
} },
nickname = "getDeviceTypeByDeviceTypeName"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse(code = 200, message = "OK. \n Successfully fetched the device type.", @ApiResponse(code = 200, message = "OK. \n Successfully fetched the device type.",

9
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/GeoLocationBasedService.java
Unescape View File

@ -419,7 +419,7 @@ public interface GeoLocationBasedService {
required = true) required = true)
@PathParam("deviceId") String deviceId, @PathParam("deviceId") String deviceId,
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type, such as ios, android, or windows.", value = "The device type, such as ios, android, or windows.",
required = true) required = true)
@PathParam("deviceType") @PathParam("deviceType")
@ -538,7 +538,7 @@ public interface GeoLocationBasedService {
required = true) required = true)
@PathParam("deviceId") String deviceId, @PathParam("deviceId") String deviceId,
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type, such as ios, android, or windows.", value = "The device type, such as ios, android, or windows.",
required = true) required = true)
@PathParam("deviceType") @PathParam("deviceType")
@ -655,7 +655,7 @@ public interface GeoLocationBasedService {
required = true) required = true)
@PathParam("deviceId") String deviceId, @PathParam("deviceId") String deviceId,
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type, such as ios, android. or windows.", value = "The device type, such as ios, android. or windows.",
required = true) required = true)
@PathParam("deviceType") @PathParam("deviceType")
@ -1022,7 +1022,8 @@ public interface GeoLocationBasedService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:geo-service:geo-fence") @ExtensionProperty(name = Constants.SCOPE, value = "perm:geo-service:geo-fence")
}) })
} },
nickname = "getGeofenceByFenceId"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse( @ApiResponse(

20
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/GroupManagementService.java
Unescape View File

@ -213,7 +213,8 @@ public interface GroupManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:groups") @ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:groups")
}) })
} },
nickname = "getGroupsWithFilter"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse(code = 200, message = "OK. \n Successfully fetched the list of device groups.", @ApiResponse(code = 200, message = "OK. \n Successfully fetched the list of device groups.",
@ -287,7 +288,8 @@ public interface GroupManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:groups") @ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:groups")
}) })
} },
nickname = "getGroupsWithHierarchyNonAdmin"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse(code = 200, message = "OK. \n Successfully fetched the list of device hierarchical groups.", @ApiResponse(code = 200, message = "OK. \n Successfully fetched the list of device hierarchical groups.",
@ -367,7 +369,8 @@ public interface GroupManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:count") @ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:count")
}) })
} },
nickname = "getGroupCountNonAdmin"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ -411,7 +414,8 @@ public interface GroupManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:add") @ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:add")
}) })
} },
nickname = "createGroupByGroupObject"
) )
@ApiResponses( @ApiResponses(
value = { value = {
@ -545,7 +549,8 @@ public interface GroupManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:groups-view") @ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:groups-view")
}) })
} },
nickname = "getGroupByGroupNameFilter"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse(code = 200, message = "OK. \n Successfully fetched the device group.", @ApiResponse(code = 200, message = "OK. \n Successfully fetched the device group.",
@ -760,7 +765,7 @@ public interface GroupManagementService {
response = ErrorResponse.class) response = ErrorResponse.class)
}) })
Response manageGroupSharing(@ApiParam( Response manageGroupSharing(@ApiParam(
name = "groupName", name = "groupId",
value = "Name of the group to be shared or unshared.", value = "Name of the group to be shared or unshared.",
required = true) required = true)
@PathParam("groupId") int groupId, @PathParam("groupId") int groupId,
@ -1130,7 +1135,8 @@ public interface GroupManagementService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:device") @ExtensionProperty(name = Constants.SCOPE, value = "perm:groups:device")
}) })
} },
nickname = "getGroupsNonAdmin"
) )
@ApiResponses(value = { @ApiResponses(value = {
@ApiResponse(code = 200, message = "OK.", @ApiResponse(code = 200, message = "OK.",

3
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/PolicyManagementService.java
Unescape View File

@ -785,7 +785,8 @@ public interface PolicyManagementService {
httpMethod = "GET", httpMethod = "GET",
value = "Getting Details of Policies", value = "Getting Details of Policies",
responseContainer = "List", responseContainer = "List",
notes = "Retrieve the details of all the policies filtered by policy type in WSO2 EMM.", notes = "Retrieve the details of all the policies filtered by policy type in Entgra " +
"EMM.",
response = Policy.class, response = Policy.class,
tags = "Device Policy Management", tags = "Device Policy Management",
extensions = { extensions = {

2
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/RemoteSessionService.java
Unescape View File

@ -122,7 +122,7 @@ public interface RemoteSessionService {
required = true) required = true)
@PathParam("deviceId") String deviceId, @PathParam("deviceId") String deviceId,
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type, such as ios, android, or windows.", value = "The device type, such as ios, android, or windows.",
required = true) required = true)
@PathParam("deviceType") @PathParam("deviceType")

4
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/ReportManagementService.java
Unescape View File

@ -471,10 +471,10 @@ public interface ReportManagementService {
}) })
Response getAppNotInstalledDevices( Response getAppNotInstalledDevices(
@ApiParam( @ApiParam(
name = "device-type", name = "deviceType",
value = "The device type name, such as ios, android, windows, or fire-alarm.", value = "The device type name, such as ios, android, windows, or fire-alarm.",
required = true) required = true)
@PathParam("device-type") @PathParam("deviceType")
String deviceType, String deviceType,
@ApiParam( @ApiParam(
name = "package-name", name = "package-name",

2
components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/admin/DeviceTypeManagementAdminService.java
Unescape View File

@ -386,7 +386,7 @@ public interface DeviceTypeManagementAdminService {
@POST @POST
@Path("/versions") @Path("/{deviceTypeName}/versions")
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@ApiOperation( @ApiOperation(

Write Preview
Loading…
Cancel
Save