Merge pull request #11013 from IQSS/11012-get-dataverse-api-ext

ofahimIQSS · web-flow · commit befc5a9ee6da · 2024-11-13T15:05:22.000-05:00
Extend getDataverse API json payload to include properties isMetadataBlockRoot and isFacetRoot
diff --git a/doc/release-notes/11012-get-dataverse-api-ext.md b/doc/release-notes/11012-get-dataverse-api-ext.md
@@ -0,0 +1 @@
+The JSON payload of the getDataverse endpoint has been extended to include properties isMetadataBlockRoot and isFacetRoot.
diff --git a/src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java b/src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java
@@ -276,7 +276,9 @@ public static JsonObjectBuilder json(Dataverse dv, Boolean hideEmail, Boolean re
         }
         bld.add("permissionRoot", dv.isPermissionRoot())
                 .add("description", dv.getDescription())
-                .add("dataverseType", dv.getDataverseType().name());
+                .add("dataverseType", dv.getDataverseType().name())
+                .add("isMetadataBlockRoot", dv.isMetadataBlockRoot())
+                .add("isFacetRoot", dv.isFacetRoot());
         if (dv.getOwner() != null) {
             bld.add("ownerId", dv.getOwner().getId());
         }
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/DataversesIT.java b/src/test/java/edu/harvard/iq/dataverse/api/DataversesIT.java
@@ -135,14 +135,16 @@ public void testDataverseCategory() {
     public void testMinimalDataverse() throws FileNotFoundException {
         Response createUser = UtilIT.createRandomUser();
         createUser.prettyPrint();
-        String username = UtilIT.getUsernameFromResponse(createUser);
         String apiToken = UtilIT.getApiTokenFromResponse(createUser);
         JsonObject dvJson;
         FileReader reader = new FileReader("doc/sphinx-guides/source/_static/api/dataverse-minimal.json");
         dvJson = Json.createReader(reader).readObject();
         Response create = UtilIT.createDataverse(dvJson, apiToken);
         create.prettyPrint();
-        create.then().assertThat().statusCode(CREATED.getStatusCode());
+        create.then().assertThat()
+                .body("data.isMetadataBlockRoot", equalTo(false))
+                .body("data.isFacetRoot", equalTo(false))
+                .statusCode(CREATED.getStatusCode());
         Response deleteDataverse = UtilIT.deleteDataverse("science", apiToken);
         deleteDataverse.prettyPrint();
         deleteDataverse.then().assertThat().statusCode(OK.getStatusCode());

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+The JSON payload of the getDataverse endpoint has been extended to include properties isMetadataBlockRoot and isFacetRoot.`
Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,9 @@ public static JsonObjectBuilder json(Dataverse dv, Boolean hideEmail, Boolean re`
`276`	`276`	`}`
`277`	`277`	`bld.add("permissionRoot", dv.isPermissionRoot())`
`278`	`278`	`.add("description", dv.getDescription())`
`279`		`- .add("dataverseType", dv.getDataverseType().name());`
	`279`	`+ .add("dataverseType", dv.getDataverseType().name())`
	`280`	`+ .add("isMetadataBlockRoot", dv.isMetadataBlockRoot())`
	`281`	`+ .add("isFacetRoot", dv.isFacetRoot());`
`280`	`282`	`if (dv.getOwner() != null) {`
`281`	`283`	`bld.add("ownerId", dv.getOwner().getId());`
`282`	`284`	`}`