#8944 - Extend 'metadatablocks/{block_id}' endpoint JSON output

[JR-1991]

This is a continuation of PR #9091 due to a change of the branch name.

What this PR does / why we need it:

This PR extends the API endpoint /api/metadatablocks/{block_id} to include the following fields:

• multiple: Whether or not multiple instances of this field can exist
• isControlledVocabulary: Whether or not this field has a controlled vocabulary. Important to derive the typeClass later on
• controlledVocabularyValues - If a vocabulary is given, includes all possible values.

With this extension it is possible to build compatible Dataverse JSON files for upload and download from any installation without having access to the TSV files. EasyDataverse would greatly benefit from this and allow users to "connect" to a Dataverse installation without the need of generating specific code.

Which issue(s) this PR closes:

• Closes Extend 'metadatablocks' endpoint to include the 'multiple' field #8944
• Closes Expose Controlled Vocabulary Terms in the API #1510

Special notes for your reviewer:

None

Suggestions on how to test this:

Add or extend a fixture to test if the new fields are given upon execution.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No.

Is there a release notes update needed for this change?:

The API endpoint /api/metadatablocks/{block_id} has been extended to include the following fields:

• multiple: Whether or not multiple instances of this field can exist
• isControlledVocabulary: Whether or not this field has a controlled vocabulary.
• controlledVocabularyValues - If a vocabulary is given, includes all possible values.

Additional documentation:

None

[coveralls]

Coverage decreased (-0.002%) to 19.997% when pulling ae83c27 on 8944-metadatablocks into 120adc1 on develop.

[mreekie]

@pdurbin I removed the sizing for this. Let's talk during the standup.

[pdurbin]

@mreekie this is a one to one replacement. I carefully copied everything over. Yes, let's discuss!

[pdurbin]

@JR-1991 I went ahead and added some docs and a release note. Please take a look:

ae83c27 add docs #8944
2a87ae5 add release note #8944

You can preview the doc changes here:

• https://dataverse-guide--9213.org.readthedocs.build/en/9213/api/native-api.html#metadata-blocks-api
• https://dataverse-guide--9213.org.readthedocs.build/en/9213/admin/metadatacustomization.html#exploring-metadata-blocks

I think this is ready for QA but at standup I plan on explaining that we could do a bit more work:

• add tests for the isControlledVocabulary and multiple
• get controlledVocabularyValues with non-English values

We could also defer this work, of course.

[JR-1991]

@pdurbin thanks for adding the docs and release notes! From my side everything looks fine :-)

[pdurbin]

The new API test is passing (as are all other API tests): https://jenkins.dataverse.org/job/IQSS-Dataverse-Develop-PR/job/PR-9213/2/testReport/edu.harvard.iq.dataverse.api/MetadataBlocksIT/testGetCitationBlock/

Discussed at standup. Everyone seems ok with moving this to QA, especially because we'd probably need to do the extra work (supporting non-English languages) ourselves because the branch is in the IQSS repo and we're not sure if @JR-1991 can quickly add this. We'll wait until someone asks for it. Maybe @JayanthyChengan will save us again. 😅

Approved. Moving to QA.