-
Notifications
You must be signed in to change notification settings - Fork 490
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
Dataset files API extension for search text filtering #9820
Conversation
…taverse into 9785-files-api-extension-search
This comment has been minimized.
This comment has been minimized.
…taverse into 9785-files-api-extension-search
This comment has been minimized.
This comment has been minimized.
@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
This comment has been minimized.
This comment has been minimized.
…taverse into 9785-files-api-extension-search
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this 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
@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
📦 Pushed preview images as
🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
@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! |
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). |
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