IQSS / dataverse-client-javascript

A Dataverse client for JavaScript and TypeScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Optimize getDataset use case to use the new API query param includeFiles=false to avoid unnecessary file lookups

GPortas opened this issue · comments

Overview of the Feature Request

A new optimization has been recently added to the getVersion endpoint, which is the API endpoint used by the getDataset use case: https://github.com/IQSS/dataverse/blob/develop/src/main/java/edu/harvard/iq/dataverse/api/Datasets.java#L489.

A new query parameter "includeFiles" has been included that supports the option of excluding the file metadatas lookup from the endpoint search. Since we are only interested in the dataset info and not the files metadata (which we recover from other endpoint) we want to use the new query param set to false.

What kind of user is the feature intended for?

Package consumer

What inspired the request?

  • Recent API optimization

What existing behavior do you want changed?

None

Any brand new behavior do you want to add to Dataverse?

None

Any open or closed issues related to this feature request?

None