Merge pull request #11589 from poikilotherm/11573-print-datasettype

Add datasetType to JSON serialization of DatasetVersion

Author: ofahimIQSS

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

@@ -1583,6 +1583,9 @@ The fully expanded example above (without environment variables) looks like this
 
   curl "https://demo.dataverse.org/api/datasets/24/versions/1.0?excludeFiles=false"
 
+Note: the data object will contain the fields ``datasetId``, ``datasetPersistentId`` (since `4.18 <https://github.com/IQSS/dataverse/issues/6397>`_) and ``datasetType`` (since `6.7 <https://github.com/IQSS/dataverse/issues/11573>`_).
+All of these fields are equal and constant for all versions of a dataset.
+
 The optional ``excludeFiles`` parameter specifies whether the files should be listed in the output (defaults to ``true``). Note that a separate ``/files`` API can be used for listing the files, or a subset thereof in a given version. 
 
 .. code-block:: bash

src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java

@@ -474,6 +474,7 @@ public static JsonObjectBuilder json(DatasetVersion dsv, List<String> anonymized
         JsonObjectBuilder bld = jsonObjectBuilder()
                 .add("id", dsv.getId()).add("datasetId", dataset.getId())
                 .add("datasetPersistentId", dataset.getGlobalId().asString())
+                .add("datasetType", dataset.getDatasetType().getName())
                 .add("storageIdentifier", dataset.getStorageIdentifier())
                 .add("versionNumber", dsv.getVersionNumber())
                 .add("internalVersionNumber", dsv.getVersion())

src/test/java/edu/harvard/iq/dataverse/util/json/JsonPrinterTest.java

@@ -5,6 +5,7 @@
 import edu.harvard.iq.dataverse.authorization.DataverseRole;
 import edu.harvard.iq.dataverse.authorization.RoleAssignee;
 import edu.harvard.iq.dataverse.authorization.users.PrivateUrlUser;
+import edu.harvard.iq.dataverse.dataset.DatasetType;
 import edu.harvard.iq.dataverse.dataverse.featured.DataverseFeaturedItem;
 import edu.harvard.iq.dataverse.mocks.MockDatasetFieldSvc;
 import edu.harvard.iq.dataverse.pidproviders.doi.AbstractDOIProvider;
@@ -477,6 +478,22 @@ public void testDataverseFeaturedItemDatafileTest() {
 
         assertNotNull(jsonObject);
     }
+    
+    @Test
+    public void testDatasetWithNondefaultType() {
+        String sut = "foobar";
+        DatasetType foobar = new DatasetType();
+        foobar.setName(sut);
+        
+        Dataset dataset = createDataset(42);
+        dataset.setDatasetType(foobar);
+        
+        var jsob = JsonPrinter.json(dataset.getLatestVersion(), false, false).build();
+        String result = jsob.getString("datasetType");
+        
+        assertNotNull(result);
+        assertEquals(sut, result);
+    }
 
     private Dataverse createDataverse(long id) {
         Dataverse dataverse = new Dataverse();
@@ -506,6 +523,7 @@ private Dataset createDataset(long id) {
         dsFields.add(titleField);
         dsVersion.setDatasetFields(dsFields);
         dsVersion.setVersionState(DatasetVersion.VersionState.RELEASED);
+        dsVersion.setTermsOfUseAndAccess(new TermsOfUseAndAccess());
         dataset.setId(id);
 
         dataset.setVersions(List.of(dsVersion));