Extend datasets' and files' property from search API endpoint #11027
Labels
FY25 Sprint 10
FY25 Sprint 10 (2024-11-06 - 2024-11-20)
FY25 Sprint 11
FY25 Sprint 11 (2024-11-20 - 2024-12-04)
FY25 Sprint 12
FY25 Sprint 12 (2024-12-04 - 2024-12-18)
GREI Re-arch
Issues related to the GREI Dataverse rearchitecture
Size: 30
A percentage of a sprint. 21 hours. (formerly size:33)
SPA.Q4.2
Collection Page: Extended item cards information
SPA
These changes are required for the Dataverse SPA
Type: Feature
a feature request
User Role: API User
Makes use of APIs
Milestone
Overview of the Feature Request
For the SPA, in order to display the lock icon, and tags/categories information for items in the collection page, we should add some extra properties to each file item from search api once
type=file
.restricted: boolean
canDownloadFile: boolean
( from file user permission)categories: array of string
"categories" would be similar to what it is in metadata api, for example,{"label":"blob","description":"","restricted":true,"categories":["Data","Documentation"],"id":6}
For tabular files, there are some properties needed additionally.
tabularTags: array of string
for example,{"tabularTags" : ["Event", "Genomics", "Geospatial"]}
variables: number/int
shows how many variables we have for the tabular fileobservations: number/int
shows how many observations for the tabular fileAlso, for dataset search api
type=dataset
, because datasets' thumbnail should be displayed, an extra property is needed.thumbnail: string
What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
API User
What inspired the request?
Q4 roadmap, Q4.2
What existing behavior do you want changed?
None
Any brand new behavior do you want to add to Dataverse?
Add extra properties
Any open or closed issues related to this feature request?
IQSS/dataverse-client-javascript#221
IQSS/dataverse-frontend#547
The text was updated successfully, but these errors were encountered: