file citation via API

[pdurbin]

What this PR does / why we need it:

Returns a file citation like this:

{
    "status": "OK",
    "data": {
        "message": "Finch, Fiona, 2024, \"Darwin's Finches\", <a href=\"https://doi.org/10.5072/FK2/PULAPK\" target=\"_blank\">https://doi.org/10.5072/FK2/PULAPK</a>, Root, DRAFT VERSION; file.txt [fileName]"
    }
}

This will be used by the the file landing page in the new frontend. See IQSS/dataverse-client-javascript#117

Which issue(s) this PR closes:

• Closes Create an endpoint to retrieve the file citation #10240

Special notes for your reviewer:

As requested in the issue, I followed the conventions in for the dataset-level equivalent of getting the citation: https://guides.dataverse.org/en/6.0/api/native-api.html#get-citation It was added in PR #9592 and updated in PR #10121.

This means that passing the dataset version is required.

I'm somewhat confused by what "direct" means. I see it was added in a commit by @qqmyers in c0c852f . I hope I'm using it right. Some Javadoc would be welcome.

Suggestions on how to test this:

Create datasets, upload files, check the file citation JSON for drafts, published, and deaccessioned. Note that there are automated tests for all of these cases.

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?:

Included.

Additional documentation:

Included: https://dataverse-guide--10246.org.readthedocs.build/en/10246/api/native-api.html#get-file-citation-as-json

[coveralls]

coverage: 20.134% (-0.007%) from 20.141%
when pulling a2194d9 on 10240-file-citation
into 98231c5 on develop.

[pdurbin]

@GPortas et al., I'm ready for more review. Thanks for all the feedback so far!

[GPortas]

This is great, thanks!

[GPortas]

Looks good to me! Thank you for applying the requested changes @pdurbin

[github-actions]

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10240-file-citation

ghcr.io/gdcc/configbaker:10240-file-citation

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

[sekmiller]

@pdurbin, Should I be worried that https://dataverse-guide--10246.org.readthedocs.build/en/10246/api/native-api.html#get-file-citation-as-json looks like this in Safari?

[pdurbin]

@sekmiller huh. I can't reproduce it. It shouldn't have anything to do with this PR.