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

Dataverse Featured Items support #11124

Merged
merged 65 commits into from
Jan 29, 2025
Merged

Dataverse Featured Items support #11124

merged 65 commits into from
Jan 29, 2025

Conversation

GPortas
Copy link
Contributor

@GPortas GPortas commented Dec 23, 2024

What this PR does / why we need it:

CRUD endpoints for Collection Featured Items have been implemented. In particular, the following endpoints have been implemented:

  • Create a feature item (POST /api/dataverses/<dataverse_id>/featuredItems)
  • Update a feature item (PUT /api/dataverseFeaturedItems/<item_id>)
  • Delete a feature item (DELETE /api/dataverseFeaturedItems/<item_id>)
  • List all featured items in a collection (GET /api/dataverses/<dataverse_id>/featuredItems)
  • Delete all featured items in a collection (DELETE /api/dataverses/<dataverse_id>/featuredItems)
  • Update all featured items in a collection (PUT /api/dataverses/<dataverse_id>/featuredItems)

Which issue(s) this PR closes:

Suggestions on how to test this:

Follow the docs added to native-api to make curl calls and test the different operations on featured items.

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

No

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

Yes, attached.

Preview docs at https://dataverse-guide--11124.org.readthedocs.build/en/11124/api/native-api.html#list-all-collection-featured-items

@GPortas GPortas marked this pull request as draft December 23, 2024 12:51

This comment has been minimized.

1 similar comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

@GPortas GPortas requested a review from pdurbin January 27, 2025 15:37

This comment has been minimized.

@@ -1156,6 +1156,212 @@ Use the ``/settings`` API to enable or disable the enforcement of storage quotas

curl -X PUT -d 'true' http://localhost:8080/api/admin/settings/:UseStorageQuotas

Copy link
Member

Choose a reason for hiding this comment

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

The hierarchy of these docs seems a bit odd:

Screenshot 2025-01-27 at 11 44 06 AM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree. I have restructured it by deleting Dataverse Collection Featured Items section and reordering subsections.

@GPortas GPortas requested a review from pdurbin January 28, 2025 08:37
@GPortas GPortas removed their assignment Jan 28, 2025

This comment has been minimized.

2 similar comments

This comment has been minimized.

This comment has been minimized.

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.

Lowercase "a"

doc/sphinx-guides/source/api/native-api.rst Outdated Show resolved Hide resolved
doc/sphinx-guides/source/api/native-api.rst Outdated Show resolved Hide resolved
doc/sphinx-guides/source/api/native-api.rst Outdated Show resolved Hide resolved
doc/sphinx-guides/source/api/native-api.rst Outdated Show resolved Hide resolved

This comment has been minimized.

3 similar comments

This comment has been minimized.

This comment has been minimized.

Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10943-featured-items
ghcr.io/gdcc/configbaker:10943-featured-items

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

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 and docs look good. Approved.

@pdurbin pdurbin removed their assignment Jan 28, 2025
@ofahimIQSS ofahimIQSS self-assigned this Jan 28, 2025
@ofahimIQSS
Copy link
Contributor

Testing Passed, merging PR

@ofahimIQSS ofahimIQSS merged commit 78ac64b into develop Jan 29, 2025
14 checks passed
@ofahimIQSS ofahimIQSS deleted the 10943-featured-items branch January 29, 2025 20:28
@ofahimIQSS ofahimIQSS removed their assignment Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 10 Size: 10 A percentage of a sprint. 7 hours. SPA.Q1 Not related to any specific Q1 feature SPA.Q4 Not related to any specific Q4 feature SPA These changes are required for the Dataverse SPA
Projects
Status: Merged 🚀
Development

Successfully merging this pull request may close these issues.

API support for SPA Featured Items
4 participants