Merge pull request #10225 from IQSS/10216-metadatablocks-payload-exte…

…nsion Add displayOrder, typeClass and isRequired fields to DatasetFieldType payload
IQSS · Jan 22, 2024 · e8af210 · e8af210
2 parents 1122462 + 0f4a455
commit e8af210
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git a/doc/release-notes/10216-metadatablocks.md b/doc/release-notes/10216-metadatablocks.md
@@ -0,0 +1,5 @@
+The API endpoint `/api/metadatablocks/{block_id}` has been extended to include the following fields:
+
+- `isRequired`: Whether or not this field is required
+- `displayOrder`: The display order of the field in create/edit forms
+- `typeClass`: The type class of this field ("controlledVocabulary", "compound", or "primitive")
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
@@ -565,11 +565,14 @@ public static JsonObjectBuilder json(DatasetFieldType fld) {
         fieldsBld.add("displayName", fld.getDisplayName());
         fieldsBld.add("title", fld.getTitle());
         fieldsBld.add("type", fld.getFieldType().toString());
+        fieldsBld.add("typeClass", typeClassString(fld));
         fieldsBld.add("watermark", fld.getWatermark());
         fieldsBld.add("description", fld.getDescription());
         fieldsBld.add("multiple", fld.isAllowMultiples());
         fieldsBld.add("isControlledVocabulary", fld.isControlledVocabulary());
         fieldsBld.add("displayFormat", fld.getDisplayFormat());
+        fieldsBld.add("isRequired", fld.isRequired());
+        fieldsBld.add("displayOrder", fld.getDisplayOrder());
         if (fld.isControlledVocabulary()) {
             // If the field has a controlled vocabulary,
             // add all values to the resulting JSON

diff --git a/src/test/java/edu/harvard/iq/dataverse/api/MetadataBlocksIT.java b/src/test/java/edu/harvard/iq/dataverse/api/MetadataBlocksIT.java
@@ -25,7 +25,10 @@ void testGetCitationBlock() {
         getCitationBlock.prettyPrint();
         getCitationBlock.then().assertThat()
                 .statusCode(OK.getStatusCode())
-                .body("data.fields.subject.controlledVocabularyValues[0]", CoreMatchers.is("Agricultural Sciences"));
+                .body("data.fields.subject.controlledVocabularyValues[0]", CoreMatchers.is("Agricultural Sciences"))
+                .body("data.fields.title.displayOrder", CoreMatchers.is(0))
+                .body("data.fields.title.typeClass", CoreMatchers.is("primitive"))
+                .body("data.fields.title.isRequired", CoreMatchers.is(true));
     }
 
     @Test
@@ -37,18 +40,18 @@ void testDatasetWithAllDefaultMetadata() {
             ", response=" + createUser.prettyPrint());
         String apiToken = UtilIT.getApiTokenFromResponse(createUser);
         assumeFalse(apiToken == null || apiToken.isBlank());
-        
+
         Response createCollection = UtilIT.createRandomDataverse(apiToken);
         assumeTrue(createCollection.statusCode() < 300,
             "code=" + createCollection.statusCode() +
             ", response=" + createCollection.prettyPrint());
         String dataverseAlias = UtilIT.getAliasFromResponse(createCollection);
         assumeFalse(dataverseAlias == null || dataverseAlias.isBlank());
-        
+
         // when
         String pathToJsonFile = "scripts/api/data/dataset-create-new-all-default-fields.json";
         Response createDataset = UtilIT.createDatasetViaNativeApi(dataverseAlias, pathToJsonFile, apiToken);
-        
+
         // then
         assertEquals(CREATED.getStatusCode(), createDataset.statusCode(),
            "code=" + createDataset.statusCode() +