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

Feature Request: Extend Search API to include counts for file, dataset, collection #11065

Open
ekraffmiller opened this issue Dec 5, 2024 · 1 comment · May be fixed by #11082
Open

Feature Request: Extend Search API to include counts for file, dataset, collection #11065

ekraffmiller opened this issue Dec 5, 2024 · 1 comment · May be fixed by #11082
Labels
FY25 Sprint 12 FY25 Sprint 12 (2024-12-04 - 2024-12-18) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Size: 10 A percentage of a sprint. 7 hours. SPA.Q4.1 Collection Page: All Filtering Options SPA These changes are required for the Dataverse SPA Type: Feature a feature request

Comments

@ekraffmiller
Copy link
Contributor

Overview of the Feature Request
For the SPA Collection Page, we need to show counts of the files, datasets, and collections (dataverses) in the results. To support this, we need to add a section to the API response, to contain the counts.
If preferred, we can make this behavior optional by adding a boolean show_type_counts parameter.
For example:

total_count_per_object_type: {
  collection: 3,
  dataset: 10,
  file: 75
}

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)

What inspired the request?

What existing behavior do you want changed?

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

Any open or closed issues related to this feature request?

Are you thinking about creating a pull request for this feature?
Help is always welcome, is this feature something you or your organization plan to implement?

@ekraffmiller ekraffmiller added Type: Feature a feature request SPA These changes are required for the Dataverse SPA GREI Re-arch Issues related to the GREI Dataverse rearchitecture SPA.Q4.1 Collection Page: All Filtering Options labels Dec 5, 2024
@ekraffmiller ekraffmiller moved this to This Sprint 🏃‍♀️ 🏃 in IQSS Dataverse Project Dec 5, 2024
@ekraffmiller ekraffmiller added the Size: 10 A percentage of a sprint. 7 hours. label Dec 5, 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 10, 2024
@stevenwinship stevenwinship moved this from This Sprint 🏃‍♀️ 🏃 to In Progress 💻 in IQSS Dataverse Project Dec 10, 2024
@stevenwinship
Copy link
Contributor

@ekraffmiller Just to clarify, when you say " in the results", you are referring to the number of items returned for the page and not the total of all items found?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 12 FY25 Sprint 12 (2024-12-04 - 2024-12-18) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Size: 10 A percentage of a sprint. 7 hours. SPA.Q4.1 Collection Page: All Filtering Options SPA These changes are required for the Dataverse SPA Type: Feature a feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants