change defaultToOwner to getEffective

Author: stevenwinship

doc/release-notes/11695-change-api-get-storage-driver.md

@@ -7,6 +7,6 @@ The API for getting the Storage Driver info has been changed/extended.
 /api/admin/dataverse/{dataverse-alias}/storageDriver
 changed "message" to "name" and added "type" and "label"
 
-Also added query param for /api/admin/dataverse/{dataverse-alias}/storageDriver?defaultToOwner=true to recurse the chain of parents to find the effective storageDriver
+Also added query param for /api/admin/dataverse/{dataverse-alias}/storageDriver?getEffective=true to recurse the chain of parents to find the effective storageDriver
 
 See also [the guides](https://dataverse-guide--11664.org.readthedocs.build/en/11664/api/native-api.html#configure-a-dataset-to-store-all-new-files-in-a-specific-file-store), #11695, and #11664.

doc/sphinx-guides/source/admin/dataverses-datasets.rst

@@ -62,7 +62,7 @@ The current driver can be seen using::
 
 Or to recurse the chain of parents to find the effective storageDriver::
 
-    curl -H "X-Dataverse-key: $API_TOKEN" http://$SERVER/api/admin/dataverse/$dataverse-alias/storageDriver?defaultToOwner=true
+    curl -H "X-Dataverse-key: $API_TOKEN" http://$SERVER/api/admin/dataverse/$dataverse-alias/storageDriver?getEffective=true
 
 (Note that for ``dataverse.files.store1.label=MyLabel``, ``store1`` will be returned.)
 

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

@@ -2184,7 +2184,7 @@ public Response addRoleAssignementsToChildren(@Context ContainerRequestContext c
     @AuthRequired
     @Path("/dataverse/{alias}/storageDriver")
     public Response getStorageDriver(@Context ContainerRequestContext crc, @PathParam("alias") String alias,
-                                     @QueryParam("defaultToOwner") Boolean defaultToOwner) throws WrappedResponse {
+                                     @QueryParam("getEffective") Boolean getEffective) throws WrappedResponse {
         Dataverse dataverse = dataverseSvc.findByAlias(alias);
         if (dataverse == null) {
             return error(Response.Status.NOT_FOUND, "Could not find dataverse based on alias supplied: " + alias + ".");
@@ -2198,7 +2198,7 @@ public Response getStorageDriver(@Context ContainerRequestContext crc, @PathPara
             return wr.getResponse();
         }
 
-        if (defaultToOwner != null && defaultToOwner) {
+        if (getEffective != null && getEffective) {
             return ok(JsonPrinter.jsonStorageDriver(dataverse.getEffectiveStorageDriverId(), null));
         } else {
             return ok(JsonPrinter.jsonStorageDriver(dataverse.getStorageDriverId(), null));

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

@@ -2913,8 +2913,8 @@ static Response listStorageDrivers(String apiToken) {
     static Response getStorageDriver(String dvAlias, String apiToken) {
         return getStorageDriver(dvAlias, apiToken, null);
     }
-    static Response getStorageDriver(String dvAlias, String apiToken, Boolean defaultToOwner) {
-        String params = defaultToOwner != null ? "?defaultToOwner=" + defaultToOwner : "";
+    static Response getStorageDriver(String dvAlias, String apiToken, Boolean getEffective) {
+        String params = getEffective != null ? "?getEffective=" + getEffective : "";
         return given()
                 .header(API_TOKEN_HTTP_HEADER, apiToken)
                 .get("/api/admin/dataverse/" + dvAlias + "/storageDriver" + params);