65 - Add CitationMetadataBlock type description #67
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:
This PR adds the CitationMetadataBlock interface to define the expected citation metadata fields. This way any user accessing the dataset data through the js-dataverse module knows what to expect from the citation metadata fields.
We need this because the Citation Metadata contains required metadata fields, so they need to be declared in order to create a new dataset using the js-dataverse module. And in order to declare those fields, the user needs to know which are these required fields.
This does not apply to the other metadata blocks because the other metadata blocks are optional
Which issue(s) this PR closes:
Special notes for your reviewer:
This PR doesn't add any modification to the behaviour of the use cases, it just adds a type definition, so everything should be working as it used to
Suggestions on how to test this:
export type DatasetMetadataBlocks = [CitationMetadataBlock, ...DatasetMetadataBlock[]];Is there a release notes update needed for this change?:
No
Additional documentation: