Datasets API extension for the SPA

[GPortas]

What this PR does / why we need it:

This PR includes new endpoints to support the SPA. Specifically, to obtain the summary field names and to obtain a dataset version through a private url token.

Edit 29/05: Included endpoints for obtaining the dataset citation text

Which issue(s) this PR closes:

• Closes [Spike - API] - Extend Dataset API endpoints to support the Dataset page (SPA) #9588

Special notes for your reviewer:

The new endpoints are consumed from:

• 59 - Add new Dataset use cases to support the Dataset page (SPA) dataverse-client-javascript#60

Suggestions on how to test this:

For obtaining the Dataset summary fields:

curl -X GET http://localhost:8080/api/datasets/summaryFieldNames

If you want to test custom field retrieval, update the CustomDatasetSummaryFields setting.

For obtaining a Dataset version from a private URL token:

First, create a private URL, you can use the UI for that:

Copy the token from the generated URL, and send it to the new endpoint like this:

curl -X GET http://localhost:8080/api/datasets/privateUrlDatasetVersion/<PRIVATE_URL_TOKEN>

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

N/A

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

Not sure

Additional documentation:

N/A

[coveralls]

coverage: 20.337% (+0.004%) from 20.333% when pulling f5653e3 on 9588-datasets-api-extension into 2d29201 on develop.

[github-actions]

📦 Pushed preview application image as

ghcr.io/gdcc/dataverse:9588-datasets-api-extension

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

[pdurbin]

I merged develop in and cleaned up the tests (happy to explain more).

I left a bit of feedback on exposing database settings.

This PR needs docs. I already mentioned this to @GPortas in Braga and he said he'd add them but he's on a well-deserved vacation this week.

If we do make changes to this PR (how the APIs work), it will mean we have to change the js-dataverse PR as well.

[pdurbin]

I started a thread in Slack about being consistent in how we expose database settings: https://iqss.slack.com/archives/C010LA04BCG/p1686603802872139

This might be fine but we should make an active decision because we'll be doing this a lot for the SPA. It needs to know how the backend is configured.

[pdurbin]

I'm just putting this here the top but this PR needs:

• docs
• a release note

[pdurbin]

I added docs and a release note. Approved.

[github-actions]

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:9588-datasets-api-extension

ghcr.io/gdcc/configbaker:9588-datasets-api-extension

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.