adjusted based on comments

Author: WelschChristopher

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/history/caze/HistoricCaseInstanceQueryResource.java

@@ -40,10 +40,7 @@ public class HistoricCaseInstanceQueryResource extends HistoricCaseInstanceBaseR
     @ApiOperation(value = "Query for historic case instances", tags = {"History Case", "Query" }, nickname = "queryHistoricCaseInstance",
             notes = "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic case instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here.")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'caseInstanceId'.", allowableValues = "caseInstanceId,caseDefinitionId,startTime,endTime,tenantId", paramType = "query"),
-            @ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
-            @ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
-            @ApiImplicitParam(name = "size", dataType = "integer", value = "Number of rows to fetch, starting from start. Defaults to 10.", paramType = "query"),
+            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'caseInstanceId'.", allowableValues = "caseInstanceId,caseDefinitionId,startTime,endTime,tenantId", paramType = "body"),
     })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the case instances are returned"),

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/history/milestone/HistoricMilestoneInstanceQueryResource.java

@@ -41,10 +41,7 @@ public class HistoricMilestoneInstanceQueryResource extends HistoricMilestoneIns
     @ApiOperation(value = "Query for historic milestone instances", tags = {"History Milestone", "Query"}, nickname = "queryHistoricMilestoneInstance",
             notes = "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic milestone instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'timestamp'.", allowableValues = "milestoneName,timestamp", paramType = "query"),
-            @ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
-            @ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
-            @ApiImplicitParam(name = "size", dataType = "integer", value = "Number of rows to fetch, starting from start. Defaults to 10.", paramType = "query"),
+            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'timestamp'.", allowableValues = "milestoneName,timestamp", paramType = "body"),
     })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the milestone instances are returned"),

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/history/planitem/HistoricPlanItemInstanceQueryResource.java

@@ -41,10 +41,7 @@ public class HistoricPlanItemInstanceQueryResource extends HistoricPlanItemInsta
     @ApiOperation(value = "Query for historic plan item instances", tags = {"History PlanItem", "Query"}, nickname = "queryHistoricPlanItemInstance",
             notes = "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic plan item instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long.")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'createTime'.", allowableValues = "createTime,createdTime,endedTime,name", paramType = "query"),
-            @ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
-            @ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
-            @ApiImplicitParam(name = "size", dataType = "integer", value = "Number of rows to fetch, starting from start. Defaults to 10.", paramType = "query"),
+            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'createTime'.", allowableValues = "createTime,createdTime,endedTime,name", paramType = "body"),
     })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the plan item instances are returned"),

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/history/task/HistoricTaskInstanceQueryResource.java

@@ -40,10 +40,7 @@ public class HistoricTaskInstanceQueryResource extends HistoricTaskInstanceBaseR
     @ApiOperation(value = "Query for historic task instances", tags = {"History Task", "Query" },
             nickname = "queryHistoricTaskInstance", notes = "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic task instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The taskVariables and processVariables properties are JSON-arrays containing objects with the format as described here.")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'taskInstanceId'.", allowableValues = "deleteReason,duration,endTime,executionId,taskInstanceId,caseDefinitionId,caseInstanceId,start,assignee,taskDefinitionKey,description,dueDate,name,owner,priority,tenantId,startTime", paramType = "query"),
-            @ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
-            @ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
-            @ApiImplicitParam(name = "size", dataType = "integer", value = "Number of rows to fetch, starting from start. Defaults to 10.", paramType = "query"),
+            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'taskInstanceId'.", allowableValues = "deleteReason,duration,endTime,executionId,taskInstanceId,caseDefinitionId,caseInstanceId,start,assignee,taskDefinitionKey,description,dueDate,name,owner,priority,tenantId,startTime", paramType = "body"),
     })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the tasks are returned"),

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/runtime/caze/CaseInstanceQueryResource.java

@@ -42,10 +42,7 @@ public class CaseInstanceQueryResource extends BaseCaseInstanceResource {
                     + "\n" + "The general paging and sorting query-parameters can be used for this URL.")
 
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'id'.", allowableValues = "caseDefinitionId,caseDefinitionKey,id,startTime,tenantId,businessKey", paramType = "query"),
-            @ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
-            @ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
-            @ApiImplicitParam(name = "size", dataType = "integer", value = "Number of rows to fetch, starting from start. Defaults to 10.", paramType = "query"),
+            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'id'.", allowableValues = "caseDefinitionId,caseDefinitionKey,id,startTime,tenantId,businessKey", paramType = "body"),
     })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the case instances are returned"),

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/runtime/planitem/PlanItemInstanceQueryResource.java

@@ -41,10 +41,7 @@ public class PlanItemInstanceQueryResource extends PlanItemInstanceBaseResource
             notes = "The request body can contain all possible filters that can be used in the List plan item instances URL query. On top of these, it’s possible to provide an array of variables and caseInstanceVariables to include in the query, with their format described here.\n"
             + "\n" + "The general paging and sorting query-parameters can be used for this URL.")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'createTime'.", allowableValues = "name,createTime,startTime", paramType = "query"),
-            @ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
-            @ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
-            @ApiImplicitParam(name = "size", dataType = "integer", value = "Number of rows to fetch, starting from start. Defaults to 10.", paramType = "query"),
+            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'createTime'.", allowableValues = "name,createTime,startTime", paramType = "body"),
     })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the plan item instances are returned."),

modules/flowable-cmmn-rest/src/main/java/org/flowable/cmmn/rest/service/api/runtime/task/TaskQueryResource.java

@@ -40,10 +40,7 @@ public class TaskQueryResource extends TaskBaseResource {
     @ApiOperation(value = "Query for tasks", nickname="queryTasks", tags = {"Tasks", "Query"},
             notes = "All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of tasks (except for candidateGroupIn which is only available in this POST task query REST service), but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on task and process variables. The taskVariables and processInstanceVariables are both JSON-arrays containing objects with the format as described here.")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'id'.", allowableValues = "id,name,description,dueDate,createTime,priority,executionId,processInstanceId,tenantId,assignee,owner", paramType = "query"),
-            @ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
-            @ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
-            @ApiImplicitParam(name = "size", dataType = "integer", value = "Number of rows to fetch, starting from start. Defaults to 10.", paramType = "query"),
+            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'id'.", allowableValues = "id,name,description,dueDate,createTime,priority,executionId,processInstanceId,tenantId,assignee,owner", paramType = "body"),
     })
     @ApiResponses(value = {
             @ApiResponse(code = 200, message = "Indicates request was successful and the tasks are returned."),

modules/flowable-common-rest/src/main/java/org/flowable/common/rest/api/PaginateListUtil.java

@@ -107,11 +107,11 @@ static <RES, REQ> DataResponse<RES> paginateList(PaginateRequest paginateRequest
         String sort = paginateRequest.getSort();
         if (sort == null) {
             sort = defaultSort;
-        }        if (order == null) {
-            order = "asc";
         }
         String order = paginateRequest.getOrder();
-
+        if (order == null) {
+            order = "asc";
+        }
 
         // Sort order
         if (sort != null && properties != null && !properties.isEmpty()) {

modules/flowable-common-rest/src/main/java/org/flowable/common/rest/api/PaginateRequest.java

@@ -12,6 +12,8 @@
  */
 package org.flowable.common.rest.api;
 
+import io.swagger.annotations.ApiParam;
+
 /**
  * Interface representing a paginated request object, use when paging is needed without using URL-parameters.
  * 
@@ -33,6 +35,7 @@ public Integer getStart() {
         return start;
     }
 
+    @ApiParam(value = "From the paginate request. Index of the first row to fetch. Defaults to 0.")
     public void setStart(Integer start) {
         this.start = start;
     }
@@ -41,6 +44,7 @@ public Integer getSize() {
         return size;
     }
 
+    @ApiParam(name = "size", type = "integer", value = "From the paginate request. Number of rows to fetch, starting from start. Defaults to 10.", required = false)
     public void setSize(Integer size) {
         this.size = size;
     }
@@ -57,6 +61,7 @@ public String getOrder() {
         return order;
     }
 
+    @ApiParam(name = "order", type = "string", value = "From the paginate request.  The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", required = false)
     public void setOrder(String order) {
         this.order = order;
     }

…uery/ExternalWorkerJobQueryResource.java …ExternalWorkerJobCollectionResource.javamodules/flowable-external-job-rest/src/main/java/org/flowable/external/job/rest/service/api/query/ExternalWorkerJobQueryResource.java renamed to modules/flowable-external-job-rest/src/main/java/org/flowable/external/job/rest/service/api/query/ExternalWorkerJobCollectionResource.java modules/flowable-external-job-rest/src/main/java/org/flowable/external/job/rest/service/api/query/ExternalWorkerJobQueryResource.java renamed to modules/flowable-external-job-rest/src/main/java/org/flowable/external/job/rest/service/api/query/ExternalWorkerJobCollectionResource.java

@@ -38,7 +38,7 @@
  */
 @RestController
 @Api(tags = { "Info and Query" })
-public class ExternalWorkerJobQueryResource extends ExternalWorkerJobBaseResource {
+public class ExternalWorkerJobCollectionResource extends ExternalWorkerJobBaseResource {
 
     public static final Map<String, QueryProperty> PROPERTIES;
 
@@ -55,17 +55,14 @@ public class ExternalWorkerJobQueryResource extends ExternalWorkerJobBaseResourc
 
     protected final ExternalJobRestResponseFactory restResponseFactory;
 
-    public ExternalWorkerJobQueryResource(ExternalJobRestResponseFactory restResponseFactory) {
+    public ExternalWorkerJobCollectionResource(ExternalJobRestResponseFactory restResponseFactory) {
         this.restResponseFactory = restResponseFactory;
     }
 
     @ApiOperation(value = "List External Worker Jobs", tags = { "Info and Query" })
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'id'.", allowableValues = "id,dueDate,createTime,executionId,processInstanceId,retries,tenantId", paramType = "query"),
-            @ApiImplicitParam(name = "order", dataType = "string", value = "The sort order, either 'asc' or 'desc'. Defaults to 'asc'.", paramType = "query"),
-            @ApiImplicitParam(name = "start", dataType = "integer", value = "Index of the first row to fetch. Defaults to 0.", paramType = "query"),
-            @ApiImplicitParam(name = "size", dataType = "integer", value = "Number of rows to fetch, starting from start. Defaults to 10.", paramType = "query"),
-    })
+            @ApiImplicitParam(name = "sort", dataType = "string", value = "The field to sort by. Defaults to 'id'.", allowableValues = "id,dueDate,createTime,executionId,processInstanceId,retries,tenantId", paramType = "body"),
+   })
     @ApiResponses({
             @ApiResponse(code = 200, message = "Indicates the requested jobs were returned."),
             @ApiResponse(code = 400, message = "Indicates an illegal value has been used in a url query parameter. Status description contains additional details about the error."),