-
Notifications
You must be signed in to change notification settings - Fork 505
metadata export for drafts via API #11398
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
Open
pdurbin
wants to merge
8
commits into
develop
Choose a base branch
from
11305-export-drafts
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment has been minimized.
This comment has been minimized.
src/main/java/edu/harvard/iq/dataverse/export/ExportService.java
Outdated
Show resolved
Hide resolved
c7a9458
to
75e6247
Compare
This comment has been minimized.
This comment has been minimized.
Drafts are exported on-the-fly rather than being cached.
75e6247
to
8602eff
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
📦 Pushed preview images as
🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Croissant
Croissant and Kaggle related work
FY25 Sprint 20
FY25 Sprint 20 (2025-03-26 - 2025-04-09)
FY25 Sprint 21
FY25 Sprint 21 (2025-04-09 - 2025-04-23)
Size: 3
A percentage of a sprint. 2.1 hours.
Type: Feature
a feature request
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
#11305 explains that there are use cases where it is desirable to export metadata from datasets while they are still in draft. This pull request delivers this functionality, available via API.
Which issue(s) this PR closes:
Special notes for your reviewer:
Drafts are exported on-the-fly rather than being cached.
The export API is a bit non standard in that it doesn't support our pattern of being able to pass in either the database id or the PID of the dataset. Only the PID is supported. I didn't try to address this. My changes are backward compatible.
From https://github.com/gdcc/dataverse-exporters I only made a pull request to update the Croissant exporter. Once we merge this PR perhaps we can create issues for the remaining exporters to update them as well. Also, in that repo I believe we need to add some more docs to explain that if you upgrade to Dataverse 6.7 you should update exporter whatever to version whatever so that drafts are supported. I gave a heads up about this in the release note snippet.
I had to edit
src/main/java/edu/harvard/iq/dataverse/harvest/server/xoai/DataverseXoaiItemRepository.java
. I'm not sure the best way to test it.I took a quick look at making the "export drafts" functionality available via UI but there are a few challenges:
(!DatasetPage.dataset.deaccessioned or (DatasetPage.workingVersion.deaccessioned and DatasetPage.canUpdateDataset())) and !DatasetPage.anonymizedAccess
. I didn't want to break anything. By the way, the file page logic is simple (FilePage.fileMetadata.datasetVersion.dataset.released
) but perhaps it should match the dataset page? 🤷Suggestions on how to test this:
ddi
(ddi
andhtml
and) andschema.org
(schema.org
andcroissant
at least) had to be updated.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, included.
Additional documentation:
Preview docs at https://dataverse-guide--11398.org.readthedocs.build/en/11398/api/native-api.html#export-metadata-of-a-dataset-in-various-formats