Add askTotalCount to DeviceEvents REST API

Signed-off-by: Claudio Mezzasalma <claudio.mezzasalma@eurotech.com>
eclipse · Aug 4, 2021 · 0d2b304 · 0d2b304
1 parent c090030
commit 0d2b304
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/...esources/src/main/java/org/eclipse/kapua/app/api/resources/v1/resources/DeviceEvents.java b/...esources/src/main/java/org/eclipse/kapua/app/api/resources/v1/resources/DeviceEvents.java
@@ -60,13 +60,14 @@ public class DeviceEvents extends AbstractKapuaResource {
     /**
      * Gets the {@link DeviceEvent} list in the scope.
      *
-     * @param scopeId   The {@link ScopeId} in which to search results.
-     * @param deviceId  The id of the {@link Device} in which to search results
-     * @param resource  The resource of the {@link DeviceEvent} in which to search results
-     * @param sortParam The name of the parameter that will be used as a sorting key
-     * @param sortDir   The sort direction. Can be ASCENDING (default), DESCENDING. Case-insensitive.
-     * @param offset    The result set offset.
-     * @param limit     The result set limit.
+     * @param scopeId       The {@link ScopeId} in which to search results.
+     * @param deviceId      The id of the {@link Device} in which to search results
+     * @param resource      The resource of the {@link DeviceEvent} in which to search results
+     * @param sortParam     The name of the parameter that will be used as a sorting key
+     * @param sortDir       The sort direction. Can be ASCENDING (default), DESCENDING. Case-insensitive.
+     * @param askTotalCount Ask for the total count of the matched entities in the result
+     * @param offset        The result set offset.
+     * @param limit         The result set limit.
      * @return The {@link DeviceEventListResult} of all the deviceEvents associated to the current selected scope.
      * @throws KapuaException Whenever something bad happens. See specific {@link KapuaService} exceptions.
      * @since 1.0.0
@@ -81,6 +82,7 @@ public DeviceEventListResult simpleQuery(
             @QueryParam("endDate") DateParam endDateParam,
             @QueryParam("sortParam") String sortParam,
             @QueryParam("sortDir") @DefaultValue("ASCENDING") SortOrder sortDir,
+            @QueryParam("askTotalCount") boolean askTotalCount,
             @QueryParam("offset") @DefaultValue("0") int offset,
             @QueryParam("limit") @DefaultValue("50") int limit) throws KapuaException {
         DeviceEventQuery query = deviceEventFactory.newQuery(scopeId);
@@ -107,6 +109,7 @@ public DeviceEventListResult simpleQuery(
         if (!Strings.isNullOrEmpty(sortParam)) {
             query.setSortCriteria(query.fieldSortCriteria(sortParam, sortDir));
         }
+        query.setAskTotalCount(askTotalCount);
         query.setOffset(offset);
         query.setLimit(limit);
 

diff --git a/rest-api/resources/src/main/resources/openapi/deviceEvent/deviceEvent-scopeId-deviceId.yaml b/rest-api/resources/src/main/resources/openapi/deviceEvent/deviceEvent-scopeId-deviceId.yaml
@@ -40,6 +40,7 @@ paths:
             format: 'date-time'
         - $ref: '../openapi.yaml#/components/parameters/sortParam'
         - $ref: '../openapi.yaml#/components/parameters/sortDir'
+        - $ref: '../openapi.yaml#/components/parameters/askTotalCount'
         - $ref: '../openapi.yaml#/components/parameters/limit'
         - $ref: '../openapi.yaml#/components/parameters/offset'
       responses: