Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support get dataset citation for deaccessioned datasets via API #10121

Merged
merged 5 commits into from
Nov 21, 2023

Conversation

GPortas
Copy link
Contributor

@GPortas GPortas commented Nov 15, 2023

What this PR does / why we need it:

We need to extend the API to obtain dataset citation for a deaccessioned dataset, as the SPA needs it for displaying the citation for a deaccessioned dataset.

The getDatasetVersionCitation (/api/datasets/{id}/versions/{versionId}/citation) endpoint now accepts a new boolean optional query parameter "includeDeaccessioned", which, if enabled, causes the endpoint to consider deaccessioned versions when searching for versions to obtain the citation.

Which issue(s) this PR closes:

Suggestions on how to test this:

First, deaccession a published dataset from the UI or by using the API.

Next, call the getDatasetVersionCitation endpoint with the new query parameter:

curl -H "Accept:application/json" "$SERVER_URL/api/datasets/:persistentId/versions/$VERSION/{version}/citation?persistentId=$PERSISTENT_IDENTIFIER&includeDeaccessioned=true"

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

Yes

@GPortas GPortas changed the title 10104 get dataset citation deaccessioned Support get dataset citation for deaccessioned datasets Nov 15, 2023
@GPortas GPortas changed the title Support get dataset citation for deaccessioned datasets Support get dataset citation for deaccessioned datasets via API Nov 15, 2023
@coveralls
Copy link

coveralls commented Nov 15, 2023

Coverage Status

coverage: 20.003% (+0.007%) from 19.996%
when pulling 233da54 on 10104-get-dataset-citation-deaccessioned
into 9186b06 on develop.

This comment has been minimized.

@GPortas GPortas added the SPA These changes are required for the Dataverse SPA label Nov 15, 2023
@cmbz cmbz added the Size: 10 A percentage of a sprint. 7 hours. label Nov 20, 2023
@pdurbin pdurbin self-assigned this Nov 21, 2023
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Tests are passing and I played around with it locally. The only change I added was to update the (new) API changelog.

I plan to merge this soon.

Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10104-get-dataset-citation-deaccessioned
ghcr.io/gdcc/configbaker:10104-get-dataset-citation-deaccessioned

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

@pdurbin pdurbin merged commit 454e0bb into develop Nov 21, 2023
20 checks passed
@pdurbin pdurbin deleted the 10104-get-dataset-citation-deaccessioned branch November 21, 2023 16:51
@pdurbin pdurbin added this to the 6.1 milestone Nov 21, 2023
@pdurbin pdurbin removed their assignment Nov 21, 2023
@pdurbin pdurbin mentioned this pull request Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Spike - API] Support get dataset citation for deaccessioned datasets
4 participants