Skip to content
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

Extend datasets' and files' property from search API endpoint #11027

Closed
ChengShi-1 opened this issue Nov 18, 2024 · 2 comments · Fixed by #11097
Closed

Extend datasets' and files' property from search API endpoint #11027

ChengShi-1 opened this issue Nov 18, 2024 · 2 comments · Fixed by #11097
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

Comments

@ChengShi-1
Copy link

ChengShi-1 commented Nov 18, 2024

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 file
  • observations: number/int shows how many observations for the tabular file

Also, 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

@ChengShi-1 ChengShi-1 added Type: Feature a feature request User Role: API User Makes use of APIs Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA GREI Re-arch Issues related to the GREI Dataverse rearchitecture SPA.Q4.2 Collection Page: Extended item cards information FY25 Sprint 10 FY25 Sprint 10 (2024-11-06 - 2024-11-20) labels Nov 18, 2024
@ChengShi-1 ChengShi-1 moved this to This Sprint 🏃‍♀️ 🏃 in IQSS Dataverse Project Nov 18, 2024
@ChengShi-1 ChengShi-1 changed the title Extend files' property from search API endpoint Extend datasets' and files' property from search API endpoint Nov 18, 2024
@cmbz cmbz added the FY25 Sprint 11 FY25 Sprint 11 (2024-11-20 - 2024-12-04) label Nov 21, 2024
@cmbz cmbz added the FY25 Sprint 12 FY25 Sprint 12 (2024-12-04 - 2024-12-18) label Dec 5, 2024
@stevenwinship stevenwinship self-assigned this Dec 11, 2024
@stevenwinship stevenwinship moved this from This Sprint 🏃‍♀️ 🏃 to In Progress 💻 in IQSS Dataverse Project Dec 11, 2024
@stevenwinship
Copy link
Contributor

stevenwinship commented Dec 12, 2024

Bumping the size to 30

@stevenwinship stevenwinship added Size: 30 A percentage of a sprint. 21 hours. (formerly size:33) and removed Size: 10 A percentage of a sprint. 7 hours. labels Dec 12, 2024
@stevenwinship
Copy link
Contributor

stevenwinship commented Dec 12, 2024

RE:
Also, for dataset search api type=dataset, because datasets' thumbnail should be displayed, an extra property is needed. thumbnail: string

The thumbnail url is already included in the search result for datasets
"image_url": "http://localhost:8080/api/datasets/3/logo",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants