Merge pull request #11728 from IQSS/11724-extend-list-dataverse-collection-links

extend list dataverse collection links api

Author: ofahimIQSS

doc/release-notes/11724-extend-list-dataverse-collection-links.md

@@ -0,0 +1 @@
+The [API for listing the collections a dataverse has been linked to](https://guides.dataverse.org/en/latest/admin/dataverses-datasets.html#list-dataverse-collection-links) (`api/dataverses/$dataverse-alias/links`) has been refactored to return a new Json format. This is a breaking API.

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

@@ -1692,13 +1692,21 @@ public Response listLinks(@Context ContainerRequestContext crc, @PathParam("iden
             List<Dataverse> dvsThisDvHasLinkedToList = dataverseSvc.findDataversesThisIdHasLinkedTo(dv.getId());
             JsonArrayBuilder dvsThisDvHasLinkedToBuilder = Json.createArrayBuilder();
             for (Dataverse dataverse : dvsThisDvHasLinkedToList) {
-                dvsThisDvHasLinkedToBuilder.add(dataverse.getAlias());
+                JsonObjectBuilder job = Json.createObjectBuilder();
+                job.add("id", dataverse.getId());
+                job.add("alias", dataverse.getAlias());
+                job.add("displayName", dataverse.getDisplayName());
+                dvsThisDvHasLinkedToBuilder.add(job);
             }
 
             List<Dataverse> dvsThatLinkToThisDvList = dataverseSvc.findDataversesThatLinkToThisDvId(dv.getId());
             JsonArrayBuilder dvsThatLinkToThisDvBuilder = Json.createArrayBuilder();
             for (Dataverse dataverse : dvsThatLinkToThisDvList) {
-                dvsThatLinkToThisDvBuilder.add(dataverse.getAlias());
+                JsonObjectBuilder job = Json.createObjectBuilder();
+                job.add("id", dataverse.getId());
+                job.add("alias", dataverse.getAlias());
+                job.add("displayName", dataverse.getDisplayName());
+                dvsThatLinkToThisDvBuilder.add(job);
             }
 
             List<Dataset> datasetsThisDvHasLinkedToList = dataverseSvc.findDatasetsThisIdHasLinkedTo(dv.getId());

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

@@ -121,6 +121,7 @@ public void testCreateDeleteDataverseLink() {
         Response createDataverseResponse2 = UtilIT.createRandomDataverse(apiToken);
         createDataverseResponse2.prettyPrint();
         String dataverseAlias2 = UtilIT.getAliasFromResponse(createDataverseResponse2);
+        Integer dataverseId2 = UtilIT.getDataverseIdFromResponse(createDataverseResponse2);
 
         Response createLinkingDataverseResponse = UtilIT.createDataverseLink(dataverseAlias, dataverseAlias2, apiToken);
         createLinkingDataverseResponse.prettyPrint();
@@ -138,12 +139,16 @@ public void testCreateDeleteDataverseLink() {
         getLinksResponse.prettyPrint();
         getLinksResponse.then().assertThat()
                 .statusCode(OK.getStatusCode())
-                .body("data.dataversesLinkingToThis[0]", equalTo(dataverseAlias2));
+                .body("data.dataversesLinkingToThis[0].id", equalTo(dataverseId2))
+                .body("data.dataversesLinkingToThis[0].alias", equalTo(dataverseAlias2))
+                .body("data.dataversesLinkingToThis[0].displayName", equalTo(dataverseAlias2));
         getLinksResponse = UtilIT.getDataverseLinks(dataverseAlias2, apiToken);
         getLinksResponse.prettyPrint();
         getLinksResponse.then().assertThat()
                 .statusCode(OK.getStatusCode())
-                .body("data.linkedDataverses[0]", equalTo(dataverseAlias));
+                .body("data.linkedDataverses[0].id", equalTo(dataverseId))
+                .body("data.linkedDataverses[0].alias", equalTo(dataverseAlias))
+                .body("data.linkedDataverses[0].displayName", equalTo(dataverseAlias));
 
         Response deleteLinkingDataverseResponse = UtilIT.deleteDataverseLink(dataverseAlias, dataverseAlias2, apiToken);
         deleteLinkingDataverseResponse.prettyPrint();