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

Dataset files API extension for search text filtering #9820

Merged

Conversation

GPortas
Copy link
Contributor

@GPortas GPortas commented Aug 23, 2023

What this PR does / why we need it:

Includes new optional searchText query parameter to the getVersionFiles endpoint.

Which issue(s) this PR closes:

Special notes for your reviewer:

This is an initial implementation where the search is done through DB queries in all cases, so Solr is not used.

Therefore, this implementation is subject to change. Especially after completing #9813.

Suggestions on how to test this:

Upload a test file to Dataverse, with a label or description you can search based on.

curl -H "X-Dataverse-Key: <YOUR_API_KEY>" -X GET "http://localhost:8080/api/v1/datasets/:persistentId/versions/:latest/files?persistentId=<DATASED_PID>&searchText=<SEARCH_TEXT>"

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

Additional documentation:

N/A

@GPortas GPortas added this to Ready for Review ⏩ in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) via automation Aug 23, 2023
@GPortas GPortas moved this from Ready for Review ⏩ to ▶ SPRINT READY in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Aug 23, 2023
@GPortas GPortas added the Status: Waiting issues in need of input from someone currently unavailable label Aug 23, 2023
@GPortas GPortas added this to the 6.1 milestone Aug 23, 2023
…taverse into 9785-files-api-extension-search
@github-actions

This comment has been minimized.

…taverse into 9785-files-api-extension-search
@github-actions

This comment has been minimized.

@scolapasta scolapasta removed the Status: Waiting issues in need of input from someone currently unavailable label Sep 11, 2023
@scolapasta scolapasta moved this from ▶ SPRINT READY to Ready for Review ⏩ in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Sep 11, 2023
@scolapasta
Copy link
Contributor

@GPortas I'll move this milestone 6.1 issue to "ready for Review", but I'm assigning you first so that you can handle the 6.0 merge and address any EE10 issues.

…taverse into 9785-files-api-extension-search
@GPortas GPortas removed their assignment Sep 12, 2023
@github-actions

This comment has been minimized.

@GPortas GPortas added the Size: 3 A percentage of a sprint. 2.1 hours. label Sep 13, 2023
…taverse into 9785-files-api-extension-search
@github-actions

This comment has been minimized.

@sekmiller sekmiller self-assigned this Sep 26, 2023
Copy link
Contributor

@sekmiller sekmiller left a comment

Choose a reason for hiding this comment

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

Looks good. Just make sure that you continue to update from dev as necessary

IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Ready for Review ⏩ to Ready for QA ⏩ Sep 26, 2023
@sekmiller sekmiller assigned GPortas and unassigned sekmiller Sep 26, 2023
@sekmiller
Copy link
Contributor

@GPortas I just re-assigned you to remind you to make sure that the branch is up to date with dev. Thanks!

…taverse into 9785-files-api-extension-search
@GPortas GPortas removed their assignment Sep 27, 2023
@github-actions
Copy link

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:9785-files-api-extension-search
ghcr.io/gdcc/configbaker:9785-files-api-extension-search

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

@kcondon
Copy link
Contributor

kcondon commented Sep 28, 2023

@GPortas This works for some values but not sure of the scope of what it supports. It supports what would be search terms from the dataset files tab, ie. description, filename. It also supports file extension but couldn't get it to support file type as displayed on the page. Also, the filters, File type, Access, File tag didn't seem to work. Could you clarify what it should do? Thanks!

@kcondon kcondon merged commit 0de95c4 into 9714-files-api-extension-filters Sep 28, 2023
17 of 18 checks passed
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Ready for QA ⏩ to Done 🚀 Sep 28, 2023
@kcondon kcondon deleted the 9785-files-api-extension-search branch September 28, 2023 20:46
@GPortas
Copy link
Contributor Author

GPortas commented Oct 3, 2023

@kcondon

Sorry, my understanding was that the feature was not quite relevant. This is probably a misunderstanding I had from one of the frontend weekly discussions.

I appreciate the context on this. Since I still have to refine the last PR (the final one pointing to develop), which includes all these changes, I can evaluate if we can add the tabular tag filter along with the rest of the filter options in a direct way.

I will review this in addition to what you already mentioned on #9820 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: 3 A percentage of a sprint. 2.1 hours.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants