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

11127 search api DV Object Type counts extended #11138

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from

Conversation

sekmiller
Copy link
Contributor

@sekmiller sekmiller commented Jan 8, 2025

What this PR does / why we need it: Extends the Search API so that if show_type_counts is true then each dv object type will be returned including when the count is 0 - or even if there are no actual results in the search return.

Which issue(s) this PR closes:

Special notes for your reviewer: Pretty straight forward. Added tests to Search IT. Did see some weirdness with my local solr install that seem to be unrelated to this, and I was able to resolve them.

Suggestions on how to test this: Good examples in the ticket. You'll need to exercise the Search API in a way that the results include only some of the object types or return no records at all

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?: Yes, included

Additional documentation: the Search API documentation does not show the previous behavior of including the show-type-counts param. Should it be added or is this more like an SPA feature that we don't expect regular api users to use?

@sekmiller sekmiller self-assigned this Jan 8, 2025

This comment has been minimized.

@sekmiller sekmiller removed their assignment Jan 8, 2025
@sekmiller sekmiller added FY25 Sprint 14 FY25 Sprint 14 (2025-01-02 - 2025-01-15) Size: 3 A percentage of a sprint. 2.1 hours. labels Jan 8, 2025

This comment has been minimized.

This comment has been minimized.

@coveralls
Copy link

coveralls commented Jan 14, 2025

Coverage Status

coverage: 22.748% (-0.005%) from 22.753%
when pulling cbeb27c on 11127-search-api-counts
into bf1e3f8 on develop.

This comment has been minimized.

@g-saracca g-saracca added SPA These changes are required for the Dataverse SPA SPA.Q4.1 Collection Page: All Filtering Options Original size: 3 GREI Re-arch Issues related to the GREI Dataverse rearchitecture labels Jan 14, 2025
@GPortas GPortas added the SPA.Q1 Not related to any specific Q1 feature label Jan 15, 2025

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

@g-saracca
Copy link
Contributor

I tested this while extending the Get Collection Items use case in js-dataverse with this PR preview image and it works like a charm. 👏🏼

This comment has been minimized.

@sekmiller sekmiller changed the title 11127 search api counts 11127 search api DV Object Type counts extended Jan 22, 2025

This comment has been minimized.

This comment has been minimized.

Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11127-search-api-counts
ghcr.io/gdcc/configbaker:11127-search-api-counts

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 14 FY25 Sprint 14 (2025-01-02 - 2025-01-15) FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q1 Not related to any specific Q1 feature SPA.Q4.1 Collection Page: All Filtering Options SPA These changes are required for the Dataverse SPA
Projects
Status: Ready for Review ⏩
Development

Successfully merging this pull request may close these issues.

Search API - Counts per object type behavior
5 participants