mirror of
https://repository.entgra.net/community/device-mgt-core.git
synced 2025-10-06 02:01:45 +00:00
Merge branch 'swagger-fix' into 'master'
Swagger fix See merge request entgra/carbon-device-mgt!921
This commit is contained in:
commit
3332d8e85e
@ -88,7 +88,7 @@ public interface ArtifactDownloadAPI {
|
|||||||
required = true)
|
required = true)
|
||||||
@PathParam("tenantId") int tenantId,
|
@PathParam("tenantId") int tenantId,
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "hash-value",
|
name = "appHashValue",
|
||||||
value = "Hash value of the application release.",
|
value = "Hash value of the application release.",
|
||||||
required = true)
|
required = true)
|
||||||
@PathParam("appHashValue") String uuid,
|
@PathParam("appHashValue") String uuid,
|
||||||
|
|||||||
@ -41,8 +41,8 @@
|
|||||||
<property name="host" value="localhost:9443"/>
|
<property name="host" value="localhost:9443"/>
|
||||||
<property name="schemes" value="https" />
|
<property name="schemes" value="https" />
|
||||||
<property name="basePath" value="/api/application-mgt-publisher/v1.0"/>
|
<property name="basePath" value="/api/application-mgt-publisher/v1.0"/>
|
||||||
<property name="title" value="Application Management Admin Service API Definitions"/>
|
<property name="title" value="Application Artifact Management APIs"/>
|
||||||
<property name="contact" value="dev@wso2.org"/>
|
<property name="contact" value="bizdev-group@entgra.io"/>
|
||||||
<property name="license" value="Apache 2.0"/>
|
<property name="license" value="Apache 2.0"/>
|
||||||
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
|
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
|
||||||
<property name="scan" value="true"/>
|
<property name="scan" value="true"/>
|
||||||
|
|||||||
@ -429,7 +429,8 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:update")
|
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:update")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "createCustomAppByAppWrapper"
|
||||||
)
|
)
|
||||||
@ApiResponses(
|
@ApiResponses(
|
||||||
value = {
|
value = {
|
||||||
@ -679,7 +680,7 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
@Produces(MediaType.APPLICATION_JSON)
|
@Produces(MediaType.APPLICATION_JSON)
|
||||||
@Consumes(MediaType.APPLICATION_JSON)
|
@Consumes(MediaType.APPLICATION_JSON)
|
||||||
@ApiOperation(
|
@ApiOperation(
|
||||||
consumes = MediaType.MULTIPART_FORM_DATA,
|
consumes = MediaType.APPLICATION_JSON,
|
||||||
produces = MediaType.APPLICATION_JSON,
|
produces = MediaType.APPLICATION_JSON,
|
||||||
httpMethod = "POST",
|
httpMethod = "POST",
|
||||||
value = "Upload artifacts",
|
value = "Upload artifacts",
|
||||||
@ -769,11 +770,11 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
);
|
);
|
||||||
|
|
||||||
@PUT
|
@PUT
|
||||||
@Path("/ent-app-artifacts/{deviceType}/{appId}/{uuid}")
|
@Path("/ent-app-artifact/{deviceType}/{uuid}")
|
||||||
@Produces(MediaType.APPLICATION_JSON)
|
@Produces(MediaType.APPLICATION_JSON)
|
||||||
@Consumes(MediaType.APPLICATION_JSON)
|
@Consumes(MediaType.APPLICATION_JSON)
|
||||||
@ApiOperation(
|
@ApiOperation(
|
||||||
consumes = MediaType.MULTIPART_FORM_DATA,
|
consumes = MediaType.APPLICATION_JSON,
|
||||||
produces = MediaType.APPLICATION_JSON,
|
produces = MediaType.APPLICATION_JSON,
|
||||||
httpMethod = "POST",
|
httpMethod = "POST",
|
||||||
value = "Upload artifacts",
|
value = "Upload artifacts",
|
||||||
@ -783,7 +784,8 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:update")
|
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:update")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "updateApplicationArtifactByDeviceTypeAndUUID"
|
||||||
)
|
)
|
||||||
@ApiResponses(
|
@ApiResponses(
|
||||||
value = {
|
value = {
|
||||||
@ -851,7 +853,7 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
})
|
})
|
||||||
Response updateEntAppRelease(
|
Response updateEntAppRelease(
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "UUID",
|
name = "uuid",
|
||||||
value = "Unique identifier of the ApplicationDTO Release",
|
value = "Unique identifier of the ApplicationDTO Release",
|
||||||
required = true)
|
required = true)
|
||||||
@PathParam("uuid") String applicationUUID,
|
@PathParam("uuid") String applicationUUID,
|
||||||
@ -895,7 +897,7 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
})
|
})
|
||||||
Response updatePubAppRelease(
|
Response updatePubAppRelease(
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "UUID",
|
name = "uuid",
|
||||||
value = "Unique identifier of the ApplicationDTO Release",
|
value = "Unique identifier of the ApplicationDTO Release",
|
||||||
required = true)
|
required = true)
|
||||||
@PathParam("uuid") String applicationUUID,
|
@PathParam("uuid") String applicationUUID,
|
||||||
@ -939,7 +941,7 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
})
|
})
|
||||||
Response updateWebAppRelease(
|
Response updateWebAppRelease(
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "UUID",
|
name = "uuid",
|
||||||
value = "Unique identifier of the ApplicationDTO Release",
|
value = "Unique identifier of the ApplicationDTO Release",
|
||||||
required = true)
|
required = true)
|
||||||
@PathParam("uuid") String applicationUUID,
|
@PathParam("uuid") String applicationUUID,
|
||||||
@ -984,7 +986,7 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
})
|
})
|
||||||
Response updateCustomAppRelease(
|
Response updateCustomAppRelease(
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "UUID",
|
name = "uuid",
|
||||||
value = "Unique identifier of the ApplicationDTO Release",
|
value = "Unique identifier of the ApplicationDTO Release",
|
||||||
required = true)
|
required = true)
|
||||||
@PathParam("uuid") String applicationUUID,
|
@PathParam("uuid") String applicationUUID,
|
||||||
@ -1349,7 +1351,7 @@ public interface ApplicationManagementPublisherAPI {
|
|||||||
})
|
})
|
||||||
Response addApplicationTags(
|
Response addApplicationTags(
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "oldTagName",
|
name = "appId",
|
||||||
value = "Existing Tag Name",
|
value = "Existing Tag Name",
|
||||||
required = true)
|
required = true)
|
||||||
@PathParam("appId") int appId,
|
@PathParam("appId") int appId,
|
||||||
|
|||||||
@ -309,7 +309,8 @@ public interface SPApplicationService {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
|
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "createEntAppForSP"
|
||||||
)
|
)
|
||||||
Response createEntApp(@PathParam("identity-server-id") int identityServerId,
|
Response createEntApp(@PathParam("identity-server-id") int identityServerId,
|
||||||
@PathParam("service-provider-id") String serviceProviderId, ApplicationWrapper app,
|
@PathParam("service-provider-id") String serviceProviderId, ApplicationWrapper app,
|
||||||
@ -335,7 +336,8 @@ public interface SPApplicationService {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
|
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "createPubAppForSP"
|
||||||
)
|
)
|
||||||
Response createPubApp(@PathParam("identity-server-id") int identityServerId,
|
Response createPubApp(@PathParam("identity-server-id") int identityServerId,
|
||||||
@PathParam("service-provider-id") String serviceProviderId, PublicAppWrapper app,
|
@PathParam("service-provider-id") String serviceProviderId, PublicAppWrapper app,
|
||||||
@ -358,7 +360,8 @@ public interface SPApplicationService {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
|
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "createWebAppForSP"
|
||||||
)
|
)
|
||||||
Response createWebApp(@PathParam("identity-server-id") int identityServerId,
|
Response createWebApp(@PathParam("identity-server-id") int identityServerId,
|
||||||
@PathParam("service-provider-id") String serviceProviderId, WebAppWrapper app,
|
@PathParam("service-provider-id") String serviceProviderId, WebAppWrapper app,
|
||||||
|
|||||||
@ -44,8 +44,8 @@
|
|||||||
<property name="host" value="localhost:9443"/>
|
<property name="host" value="localhost:9443"/>
|
||||||
<property name="schemes" value="https" />
|
<property name="schemes" value="https" />
|
||||||
<property name="basePath" value="/api/application-mgt-publisher/v1.0"/>
|
<property name="basePath" value="/api/application-mgt-publisher/v1.0"/>
|
||||||
<property name="title" value="Application Management Admin Service API Definitions"/>
|
<property name="title" value="Application Management Publisher API Definitions"/>
|
||||||
<property name="contact" value="dev@wso2.org"/>
|
<property name="contact" value="bizdev-group@entgra.io"/>
|
||||||
<property name="license" value="Apache 2.0"/>
|
<property name="license" value="Apache 2.0"/>
|
||||||
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
|
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
|
||||||
<property name="scan" value="true"/>
|
<property name="scan" value="true"/>
|
||||||
|
|||||||
@ -360,7 +360,8 @@ public interface ReviewManagementAPI {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = SCOPE, value = "perm:app:review:update")
|
@ExtensionProperty(name = SCOPE, value = "perm:app:review:update")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "deleteReviewComment"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ApiResponses(
|
@ApiResponses(
|
||||||
|
|||||||
@ -112,7 +112,7 @@ public interface SubscriptionManagementAPI {
|
|||||||
})
|
})
|
||||||
Response performAppOperationForDevices(
|
Response performAppOperationForDevices(
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "installationDetails",
|
name = "uuid",
|
||||||
value = "The application ID and list of devices/users/roles",
|
value = "The application ID and list of devices/users/roles",
|
||||||
required = true
|
required = true
|
||||||
)
|
)
|
||||||
@ -124,8 +124,8 @@ public interface SubscriptionManagementAPI {
|
|||||||
)
|
)
|
||||||
@PathParam("action") String action,
|
@PathParam("action") String action,
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "installationDetails",
|
name = "deviceIdentifiers",
|
||||||
value = "The application ID and list of devices/users/roles",
|
value = "The list of device identifiers",
|
||||||
required = true
|
required = true
|
||||||
)
|
)
|
||||||
@Valid List<DeviceIdentifier> deviceIdentifiers,
|
@Valid List<DeviceIdentifier> deviceIdentifiers,
|
||||||
@ -227,7 +227,7 @@ public interface SubscriptionManagementAPI {
|
|||||||
})
|
})
|
||||||
Response performEntAppSubscriptionOnDevices(
|
Response performEntAppSubscriptionOnDevices(
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "UUID",
|
name = "uuid",
|
||||||
value = "The application UUID",
|
value = "The application UUID",
|
||||||
required = true
|
required = true
|
||||||
)
|
)
|
||||||
@ -239,7 +239,7 @@ public interface SubscriptionManagementAPI {
|
|||||||
)
|
)
|
||||||
@PathParam("action") String action,
|
@PathParam("action") String action,
|
||||||
@ApiParam(
|
@ApiParam(
|
||||||
name = "installationDetails",
|
name = "deviceIdentifiers",
|
||||||
value = "The list of device identifiers",
|
value = "The list of device identifiers",
|
||||||
required = true
|
required = true
|
||||||
)
|
)
|
||||||
@ -329,7 +329,8 @@ public interface SubscriptionManagementAPI {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = SCOPE, value = "perm:app:subscription:uninstall")
|
@ExtensionProperty(name = SCOPE, value = "perm:app:subscription:uninstall")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "getAppInstalledDevicesByUUID"
|
||||||
)
|
)
|
||||||
@ApiResponses(
|
@ApiResponses(
|
||||||
value = {
|
value = {
|
||||||
|
|||||||
@ -45,7 +45,7 @@
|
|||||||
<property name="schemes" value="https" />
|
<property name="schemes" value="https" />
|
||||||
<property name="basePath" value="/api/application-mgt-store/v1.0"/>
|
<property name="basePath" value="/api/application-mgt-store/v1.0"/>
|
||||||
<property name="title" value="App Store Management Service API Definitions"/>
|
<property name="title" value="App Store Management Service API Definitions"/>
|
||||||
<property name="contact" value="dev@wso2.org"/>
|
<property name="contact" value="bizdev-group@entgra.io"/>
|
||||||
<property name="license" value="Apache 2.0"/>
|
<property name="license" value="Apache 2.0"/>
|
||||||
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
|
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
|
||||||
<property name="scan" value="true"/>
|
<property name="scan" value="true"/>
|
||||||
|
|||||||
@ -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;
|
||||||
|
|||||||
@ -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() {
|
||||||
|
|||||||
@ -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) {
|
||||||
|
|||||||
@ -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(
|
||||||
|
|||||||
@ -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 = {
|
||||||
|
|||||||
@ -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")
|
||||||
@ -1027,7 +1035,8 @@ public interface DeviceManagementService {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = Constants.SCOPE, value = "perm:devices:view")
|
@ExtensionProperty(name = Constants.SCOPE, value = "perm:devices:view")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "isEnrolledByType"
|
||||||
)
|
)
|
||||||
@ApiResponses(
|
@ApiResponses(
|
||||||
value = {
|
value = {
|
||||||
@ -1286,14 +1295,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 +1324,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 +1366,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 +2556,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 +2597,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",
|
||||||
@ -2667,7 +2677,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")
|
||||||
@ -2729,7 +2739,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")
|
||||||
@ -2778,7 +2788,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(
|
||||||
@ -2867,17 +2877,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
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@ -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.",
|
||||||
|
|||||||
@ -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(
|
||||||
|
|||||||
@ -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.",
|
||||||
|
|||||||
@ -785,14 +785,16 @@ 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 = {
|
||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = Constants.SCOPE, value = "perm:policies:get-details")
|
@ExtensionProperty(name = Constants.SCOPE, value = "perm:policies:get-details")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "getPoliciesFilteredByType"
|
||||||
)
|
)
|
||||||
@ApiResponses(
|
@ApiResponses(
|
||||||
value = {
|
value = {
|
||||||
|
|||||||
@ -74,7 +74,7 @@ public interface RemoteSessionService {
|
|||||||
* Retrieve Analytics for the device type
|
* Retrieve Analytics for the device type
|
||||||
*/
|
*/
|
||||||
@GET
|
@GET
|
||||||
@Path("connection/{deviceType}/{deviceId}")
|
@Path("connect/{deviceType}/{deviceId}")
|
||||||
@ApiOperation(
|
@ApiOperation(
|
||||||
consumes = "application/json",
|
consumes = "application/json",
|
||||||
produces = "application/json",
|
produces = "application/json",
|
||||||
@ -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")
|
||||||
|
|||||||
@ -591,7 +591,8 @@ public interface UserManagementService {
|
|||||||
@Extension(properties = {
|
@Extension(properties = {
|
||||||
@ExtensionProperty(name = Constants.SCOPE, value = "perm:users:user-details")
|
@ExtensionProperty(name = Constants.SCOPE, value = "perm:users:user-details")
|
||||||
})
|
})
|
||||||
}
|
},
|
||||||
|
nickname = "getUsersByFilter"
|
||||||
)
|
)
|
||||||
@ApiResponses(value = {
|
@ApiResponses(value = {
|
||||||
@ApiResponse(
|
@ApiResponse(
|
||||||
|
|||||||
@ -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(
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user