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

feat(api-v2): Optionally return file values in full-text search results (DSP-1191) #1776

Merged
merged 3 commits into from Jan 11, 2021

Conversation

@benjamingeer
Copy link
Collaborator

@benjamingeer benjamingeer commented Jan 4, 2021

Resolves DSP-1191.

  • Accept parameter returnFiles=true in full-text search route, to request any file values attached to matching resources.
  • Implement this in SPARQL.
  • Support it in the search responder.
  • Add tests.
  • Add docs.
@benjamingeer benjamingeer self-assigned this Jan 4, 2021
@benjamingeer benjamingeer requested a review from SepidehAlassi Jan 4, 2021
@benjamingeer benjamingeer changed the title feat(api-v2): Optionally return image values in full-text search results (DSP-350) feat(api-v2): Optionally return image values in full-text search results (DSP-1191) Jan 7, 2021
@kilchenmann
Copy link
Collaborator

@kilchenmann kilchenmann commented Jan 7, 2021

Did I understand that correctly: If I specify the parameter "returnImageFiles=true" in my search query, I'll get back the information about images. Will this be extended for other representations (moving images, audio, document) later? But then we will have a lot of parameters.

@benjamingeer
Copy link
Collaborator Author

@benjamingeer benjamingeer commented Jan 8, 2021

@kilchenmann

Did I understand that correctly: If I specify the parameter "returnImageFiles=true" in my search query, I'll get back the information about images.

Yes.

Will this be extended for other representations (moving images, audio, document) later? But then we will have a lot of parameters.

Which other file types would you like to get? How would you do a thumbnail of an audio file?

@kilchenmann
Copy link
Collaborator

@kilchenmann kilchenmann commented Jan 8, 2021

@kilchenmann

Did I understand that correctly: If I specify the parameter "returnImageFiles=true" in my search query, I'll get back the information about images.

Yes.

Will this be extended for other representations (moving images, audio, document) later? But then we will have a lot of parameters.

Which other file types would you like to get? How would you do a thumbnail of an audio file?

I will integrate a preview for MovingImageRepresentation and a pre-listening thing of an AudioRepresentation. I did some experiments in my master thesis how we can do a "preview" of an audio file. Additional it would be nice to have a preview of a DocumentRepresentation. Anyway it would be good to know, if a resource has a file representation and we can show already in the simple list view a corresponding icon to highlight resources with file representation (similar to eMails where we see if it has an attachment or not).

@benjamingeer
Copy link
Collaborator Author

@benjamingeer benjamingeer commented Jan 8, 2021

Anyway it would be good to know, if a resource has a file representation

How about if I change the parameter to returnFiles, and it returns any representation it finds?

@kilchenmann
Copy link
Collaborator

@kilchenmann kilchenmann commented Jan 8, 2021

How about if I change the parameter to returnFiles, and it returns any representation it finds?

That would be great 👍 Thanks

@benjamingeer benjamingeer changed the title feat(api-v2): Optionally return image values in full-text search results (DSP-1191) feat(api-v2): Optionally return file values in full-text search results (DSP-1191) Jan 8, 2021
Copy link
Contributor

@SepidehAlassi SepidehAlassi left a comment

this looks great, thanks for implementing it.

@benjamingeer
Copy link
Collaborator Author

@benjamingeer benjamingeer commented Jan 11, 2021

Thanks for the review!

@benjamingeer benjamingeer merged commit 01f59bd into main Jan 11, 2021
9 checks passed
9 checks passed
Build Everything
Details
Prepare next release
Details
API Unit Tests
Details
API E2E Tests
Details
API Integration Tests
Details
Upgrade Integration Tests
Details
Docs Build Test
Details
Publish (on release only)
Details
Deploy docs (on release only)
Details
@benjamingeer benjamingeer deleted the wip/DSP-350-fulltext-images branch Jan 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants