adding description info to the fileDsc seciton in DDI CodeBook. #5051 #10938
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:
Apparently, users have been asking for this since 2018 - for tabular files that have the Description field populated, this label was never exported in the DDI (non-ingested files always had their descriptions exported, in the corresponding
<otherMat>
sections).There is no obvious field under
<fileDscr>
in the DDI Codebook schema for it - probably the reason we chose not to export it back in the day (?) - but putting it into another dedicated free text<note>
field seems like a reasonable solution.The RestAssured export tests are passing, so un-drafting the PR.
I kept the changes minimal to stay under the "3" estimate.
Which issue(s) this PR closes:
Special notes for your reviewer:
Suggestions on how to test this:
Straightforward. Upload some file that's known to be ingestable (Stata, CSV ... doesn't matter). Populate the description field in the file metadata. Publish the dataset. Look at the DDI export, the description should not be showing in the corresponding
<fileDscr ...>
, like this:For extra credit, look at the file under Data Explorer, verify that new
<notes>
element isn't causing any trouble there (the Explorer relies on the DDI for viewing and - in the latest version - editing).Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: