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.

Sign up for GitHub

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
+2,002 −101
Merged

Dataverse Featured Items support #11124

Changes from 1 commit
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
d796959
Stash: update featureItems endpoint PoC WIP
GPortas Dec 16, 2024
755fd4d
Stash: CreateDataverseFeaturedItemCommand WIP
GPortas Dec 23, 2024
67e3fe0
Changed: multiple featured item creation endpoint converted to single
GPortas Dec 24, 2024
b7352aa
Removed: unused/incorrect code
GPortas Dec 24, 2024
0744c30
Removed: unused imports
GPortas Dec 24, 2024
2c96f21
Added: persisting featured items in the database
GPortas Dec 26, 2024
9cc6117
Added: new InvalidCommandArgumentsException and using it in CreateDat…
GPortas Dec 26, 2024
11a0592
Added: endpoint for listing featured items
GPortas Dec 26, 2024
ec3b6f2
Added: returning imageUrl with new associated endpoint for retrieving…
GPortas Dec 27, 2024
ea798b8
Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…
GPortas Dec 30, 2024
160ffa5
Removed: wrongly committed files
GPortas Dec 30, 2024
f124f4a
Stash: relocating file-specific logic and unit tests in progress
GPortas Dec 30, 2024
64ec37b
Fixed: exception handling when image file is invalid in a featured item
GPortas Dec 31, 2024
98f3645
Added: tweaks and fixes for featured items
GPortas Dec 31, 2024
ea03a07
Added: flush call when saving DataverseFeaturedItem
GPortas Jan 1, 2025
ea388ba
Added: DeleteDataverseFeaturedItemCommand
GPortas Jan 1, 2025
7ede831
Added: DataverseFeaturedItems API with delete method
GPortas Jan 1, 2025
d50a943
Added: DataverseFeaturedItems API with delete method IT
GPortas Jan 1, 2025
220e02a
Added: DataverseFeaturedItemsIT assertion
GPortas Jan 1, 2025
1bc2ba7
Added: testCreateFeaturedItem IT cases
GPortas Jan 1, 2025
f7d60c7
Added: handling image file optionality in dataverse featured items
GPortas Jan 2, 2025
034cea4
Added: API endpoint for updating a dataverse featured item
GPortas Jan 2, 2025
812ff0f
Stash: endpoint for create/update/delete all dv featured items at onc…
GPortas Jan 7, 2025
adfa095
Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…
GPortas Jan 7, 2025
791336c
Stash: updateFeaturedItems endpoint WIP. Updated the endpoint to retu…
GPortas Jan 7, 2025
d1c7a04
Changed: relocated flush call to avoid unnecessary call in DataverseF…
GPortas Jan 9, 2025
b8853b7
Fixed: delete featured item inconsistencies
GPortas Jan 10, 2025
3df4723
Added: updateFeaturedItems working endpoint
GPortas Jan 10, 2025
b2c918a
Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…
GPortas Jan 10, 2025
aabc4d3
Added: deleteDataverseFeaturedItems endpoint
GPortas Jan 10, 2025
b2eca4b
Added: featured item content validation
GPortas Jan 10, 2025
b4f5ce9
Added: order featured items results by display order and missing test…
GPortas Jan 11, 2025
998cc6c
Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…
GPortas Jan 11, 2025
e265ae8
Fixed: response message string formatting
GPortas Jan 13, 2025
bff8e94
Added: featured items deletion in DeleteDataverseCommand
GPortas Jan 13, 2025
5c61511
Added: sanitizing featured item content property
GPortas Jan 13, 2025
f4b6e0c
Added: empty content validation for featured items
GPortas Jan 14, 2025
107a16e
Changed: using advanced HTML sanitization for featured item content
GPortas Jan 14, 2025
b83f79c
Added: docs for listing and deleting all featured items
GPortas Jan 14, 2025
e006780
Added: API docs for creating a collection featured item
GPortas Jan 15, 2025
d386bc6
Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…
GPortas Jan 15, 2025
a5b2687
Added: docs for updating a single featured item through API
GPortas Jan 15, 2025
651347e
Added: docs for deleting a single featured item through API
GPortas Jan 15, 2025
4503aa8
Fixed: Bundle.properties string format
GPortas Jan 15, 2025
a90b7e5
Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…
GPortas Jan 16, 2025
15568a8
Fixed: typos in Bundle.properties
GPortas Jan 16, 2025
93c1eca
Added: API docs for updating all featured items
GPortas Jan 16, 2025
13301be
Added: release notes for #10943
GPortas Jan 16, 2025
38e7d88
Changed: API endpoint route
GPortas Jan 16, 2025
c4387d5
Changed: updated release notes
GPortas Jan 21, 2025
17f523a
Changed: docs title format tweak
GPortas Jan 21, 2025
6f182d2
Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…
GPortas Jan 24, 2025
69de6dd
Fixed: DataverseFeaturedItemsIT
GPortas Jan 24, 2025
e144767
Fixed: wrong endpoint path name
GPortas Jan 27, 2025
fb61d89
Added: docs for api/access/dataverseFeaturedItemImage/{ID}
GPortas Jan 27, 2025
e91524b
Refactor: package structure for dataverse featured items
GPortas Jan 27, 2025
a986a67
Added: new settings description to #10943 release notes
GPortas Jan 27, 2025
e0aeb2f
Fixed: DataversesIT featured items imageFileUrl assertion
GPortas Jan 27, 2025
d3726f8
Fixed: doc hierarchy
GPortas Jan 28, 2025
29944a0
Changed: featured items docs hierarchy
GPortas Jan 28, 2025
4004c26
Merge branch 'develop' of github.com:IQSS/dataverse into 10943-featur…
GPortas Jan 28, 2025
497cc5d
Update doc/sphinx-guides/source/api/native-api.rst
GPortas Jan 28, 2025
1799d70
Update doc/sphinx-guides/source/api/native-api.rst
GPortas Jan 28, 2025
1aac2d5
Update doc/sphinx-guides/source/api/native-api.rst
GPortas Jan 28, 2025
a8d4a05
Update doc/sphinx-guides/source/api/native-api.rst
GPortas Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update doc/sphinx-guides/source/api/native-api.rst 
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
@GPortas @pdurbin
GPortas and pdurbin authored Jan 28, 2025
commit 1aac2d511c8f37f61aaa8930f77540434bc8bac9
2 changes: 1 addition & 1 deletion doc/sphinx-guides/source/api/native-api.rst
View file
Original file line number Diff line number Diff line change
@@ -1322,7 +1322,7 @@ Updating the featured item removing the existing image:

curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X PUT -F "content=Content for featured item." -F "displayOrder=1" "https://demo.dataverse.org/api/dataverseFeaturedItems/1"

Delete A Collection Featured Item
Delete a Collection Featured Item
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Deletes a featured item given its ``id``: