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

adding publication statuses to search api response #10738

Merged

Conversation

stevenwinship
Copy link
Contributor

@stevenwinship stevenwinship commented Aug 1, 2024

What this PR does / why we need it: The results shown on the collection page include two labels for the publication status of the object (Dataset, File or Card). "Draft" if the current version is a draft, and "Unpublished" if no previous version of the object has been published. to implement this in the SPA, we need to add publicationStatus to the search results.

Which issue(s) this PR closes: 10733

Closes #10733

Special notes for your reviewer:

Suggestions on how to test this: Make API calls to /api/search
curl -H "Authorization: Bearer $TOKEN" "http://localhost:8080/api/search?q=finch&fq=publicationStatus:Published&type=dataset"
Response should have:
"publicationStatuses":[...]

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 in PR

Additional documentation:

@stevenwinship stevenwinship added Size: 3 A percentage of a sprint. 2.1 hours. SPA These changes are required for the Dataverse SPA FY25 Sprint 3 FY25 Sprint 3 labels Aug 1, 2024
@stevenwinship stevenwinship self-assigned this Aug 1, 2024
@coveralls
Copy link

Coverage Status

coverage: 20.748% (+0.007%) from 20.741%
when pulling f028f0a on 10733-add-publication-status-to-search-api-result
into 0d27957 on develop.

Copy link

github-actions bot commented Aug 1, 2024

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10733-add-publication-status-to-search-api-result
ghcr.io/gdcc/configbaker:10733-add-publication-status-to-search-api-result

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

@stevenwinship stevenwinship removed their assignment Aug 2, 2024
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't test this but the code looks right and tests are passing. Approved.

@sekmiller sekmiller self-assigned this Aug 8, 2024
@sekmiller sekmiller merged commit 9aa402d into develop Aug 8, 2024
20 checks passed
@sekmiller sekmiller deleted the 10733-add-publication-status-to-search-api-result branch August 8, 2024 19:19
@pdurbin pdurbin added this to the 6.4 milestone Aug 8, 2024
@GPortas GPortas added SPA.Q3.1 Collection page results of all types Original size: 3 labels Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 3 FY25 Sprint 3 Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q3.1 Collection page results of all types SPA These changes are required for the Dataverse SPA
Projects
Status: Done 🧹
Development

Successfully merging this pull request may close these issues.

Add publicationStatus to Search API results
5 participants