change ignoreStats to includeStats

Author: stevenwinship

doc/release-notes/12260-get-guestbook-with-usage-and-response-counts.md

@@ -1,3 +1,2 @@
 ## API Enhancement
-API call to `/api/guestbooks/{dataverseAlias}/list` will now include `"usageCount":#` and `"responseCount":#` in the response.
-By adding the query param "ignoreStats=true" these values can be excluded for faster response.
+API call to `/api/guestbooks/{dataverseAlias}/list` can now include `"usageCount":#` and `"responseCount":#` in the response by adding the query param "includeStats=true".

doc/sphinx-guides/source/api/native-api.rst

@@ -1239,7 +1239,7 @@ The fully expanded example above (without environment variables) looks like this
 
   curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "https://demo.dataverse.org/api/guestbooks/root/list"
 
-.. note:: By adding the query param "ignoreStats=true" `usageCount` and `responseCount` values can be excluded for faster response.
+.. note:: By adding the query param "includeStats=true" `usageCount` and `responseCount` values can be added to the response.
 
 Get a Guestbook for a Dataverse Collection
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

src/main/java/edu/harvard/iq/dataverse/api/Guestbooks.java

@@ -60,7 +60,7 @@ public Response getGuestbook(@Context ContainerRequestContext crc, @PathParam("i
     @GET
     @AuthRequired
     @Path("{identifier}/list")
-    public Response getGuestbooks(@Context ContainerRequestContext crc, @PathParam("identifier") String identifier, @QueryParam("ignoreStats") boolean ignoreStats) {
+    public Response getGuestbooks(@Context ContainerRequestContext crc, @PathParam("identifier") String identifier, @QueryParam("includeStats") boolean includeStats) {
         return response( req -> {
             Dataverse dataverse = findDataverseOrDie(identifier);
             final Long dataverseId = dataverse.getId();
@@ -71,8 +71,7 @@ public Response getGuestbooks(@Context ContainerRequestContext crc, @PathParam("
             JsonArrayBuilder guestbookArray = Json.createArrayBuilder();
             JsonPrinter jsonPrinter = new JsonPrinter();
             for (Guestbook gb : guestbooks) {
-                // default is to include the stats. Ignore the stats for a faster reply if they are not needed
-                if (!ignoreStats) {
+                if (includeStats) {
                     gb.setUsageCount(guestbookService.findCountUsages(gb.getId(), dataverseId));
                     gb.setResponseCount(guestbookResponseService.findCountByGuestbookId(gb.getId(), dataverseId));
                 }

src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java

@@ -4062,7 +4062,7 @@ public void testDownloadFileWithGuestbookResponse() throws IOException, JsonPars
         assertEquals(OK.getStatusCode(), signedUrlResponse.getStatusCode());
 
         // Verify that the guestbook has proper stats
-        Response guestbookListResponse = UtilIT.getGuestbooks(dataverseAlias, ownerApiToken);
+        Response guestbookListResponse = UtilIT.getGuestbooks(dataverseAlias, ownerApiToken, true);
         guestbookListResponse.prettyPrint();
         guestbookListResponse.then().assertThat()
                 .statusCode(OK.getStatusCode())

src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

@@ -612,9 +612,13 @@ static Response getGuestbook(Long guestbookId, String apiToken) {
     }
 
     static Response getGuestbooks(String dataverseAlias, String apiToken) {
+        return getGuestbooks(dataverseAlias, apiToken, false);
+    }
+    static Response getGuestbooks(String dataverseAlias, String apiToken, boolean includeStats) {
+        String params = "?includeStats=" + includeStats;
         RequestSpecification requestSpec = given()
                 .header(API_TOKEN_HTTP_HEADER, apiToken);
-        return requestSpec.get("/api/guestbooks/" + dataverseAlias + "/list" );
+        return requestSpec.get("/api/guestbooks/" + dataverseAlias + "/list" + params );
     }
 
     static Response enableGuestbook(String dataverseAlias, Long guestbookId, String apiToken, String enable) {