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

Get Collection Items use case extension #229

Open
ekraffmiller opened this issue Dec 5, 2024 · 0 comments · May be fixed by #230
Open

Get Collection Items use case extension #229

ekraffmiller opened this issue Dec 5, 2024 · 0 comments · May be fixed by #230
Labels
FY25 Sprint 12 FY25 Sprint 12 (2024-12-04 - 2024-12-18) GREI Re-arch GREI re-architecture-related Original size: 33 Size: 33 SPA.Q4.1 Collection Page: All Filtering Options

Comments

@ekraffmiller
Copy link
Contributor

ekraffmiller commented Dec 5, 2024

As part of SPA Q4: Collections: all filtering options, we need to update getCollectionItems use case to:

Add Facets results

For the SPA Q4 feature "Collection Page: all filtering options", we need to get the facet results for the Collection Page.
Screenshot 2024-12-04 at 7 11 16 PM

To get this data, we can use the use show_facets=true param in the Dataverse Search API.
The getCollectionItems use case should be updated to return this data, possibly by adding a boolean field showFacets to the CollectionSearchCriteria object.

Filter results by facets

This is currently supported in the Dataverse Seach API by using the param fq, for example fq=publicationDate:2024. See more details in the Dataverse Search API documentation.

The CollectionSearchCriteria passed to getCollectionItems use case can be updated to included the facet queries.
Screenshot 2024-12-04 at 8 10 04 PM

Add sort order

For the SPA Q4 feature "Collection Page: all filtering options", we need to implement the Sort button on the collections page:
Screenshot 2024-12-04 at 6 43 42 PM

To support this, we need to update the CollectionSearchCriteria used in getCollectionItems use case, to include a sorting information. There are two allowed sort types: 'name' and 'date'. The sort order can also be specified as ascending or descending. See Dataverse Search API or more details.

@ekraffmiller ekraffmiller added SPA.Q4.1 Collection Page: All Filtering Options Size: 10 A percentage of a sprint. 7 hours. GREI Re-arch GREI re-architecture-related labels Dec 5, 2024
@g-saracca g-saracca moved this to This Sprint 🏃‍♀️ 🏃 in IQSS Dataverse Project Dec 5, 2024
@g-saracca g-saracca changed the title Add facet search to getCollectionItems use case Get Collection Items use case extension Dec 5, 2024
@g-saracca g-saracca moved this from This Sprint 🏃‍♀️ 🏃 to In Progress 💻 in IQSS Dataverse Project Dec 5, 2024
@g-saracca g-saracca self-assigned this Dec 5, 2024
@g-saracca g-saracca added the FY25 Sprint 12 FY25 Sprint 12 (2024-12-04 - 2024-12-18) label Dec 5, 2024
@g-saracca g-saracca removed their assignment Dec 9, 2024
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 GREI re-architecture-related Original size: 33 Size: 33 SPA.Q4.1 Collection Page: All Filtering Options
Projects
None yet
2 participants